Dit online boek over technisch schrijven maakt nu gebruik van technisch document (technische documentatie (kort gezegd) om te verwijzen naar elk document dat technische informatie bevat— in plaats van te gebruiken rapport. Het rapport is een subcategorie naast de andere soorten technische documenten die in dit boek worden besproken.
Opmerking: Dit leerboek technisch schrijven richt zich op technische schrijfvaardigheden. De technische inhoud hier is niet gegarandeerd nauwkeurig of actueel.
Achtergrond/informatieve rapporten
Dit type is het moeilijkst te definiëren, maar het is het type dat de meeste mensen schrijven. Het richt zich op een technisch onderwerp en biedt achtergrondinformatie over dat onderwerp voor een specifieke groep lezers met specifieke behoeften. Dit rapport geeft geen instructies, noch levert het aanbevelingen op een systematische manier, noch rapporteert het nieuwe en originele gegevens.
Voor een volledig hoofdstuk over dit type technisch document, zie achtergrond/informatieve rapporten
Zakelijke plannen
Een ondernemingsplan is een document dat wordt gebruikt om een nieuw bedrijf te starten of om financiering te verkrijgen voor een bedrijf dat op een belangrijke manier verandert. Ondernemingsplannen zijn belangrijke documenten voor zakenpartners die het eens moeten worden over hun plannen, voor overheidsfunctionarissen die dat plan moeten goedkeuren, en natuurlijk voor potentiële investeerders zoals banken of particulieren die het bedrijf kunnen financieren.
Zie de volledig hoofdstuk over dit type technische documentatie.
Technologie-georiënteerde gebruikershandleidingen
Kort gezegd, een handleiding voor computergebruikers biedt technische informatie over het gebruik van computerhardware of -software, inclusief aanwijzingen voor taken zoals installatie, configuratie en essentiële handelingen.
Zie de volledig hoofdstuk over dit type technische documentatie.
Gegevensrapporten
Een datarapport is een technisch document dat veel gegevens bevat in de vorm van tabellen. Het kan ook grafieken en diagrammen bevatten die de gegevens in die tabellen levendiger weergeven, evenals verklarende kruisverwijzingen waarin de belangrijkste trends en conclusies in de tabulaire gegevens worden vermeld.
Zie de compleet hoofdstuk over dit type technische documentatie.
Technische ontwerprapporten
Een technisch ontwerprapport introduceert en documenteert een technisch ontwerpproject zodat anderen kunnen begrijpen hoe het ontwerp kan worden toegepast en op de markt gebracht. Technische studenten, bijvoorbeeld, hebben geschreven over het ontwerp van een temperatuurmeet- en displaysysteem met een microcontroller.
Zie de volledig hoofdstuk over dit type technische documentatie.
Handleidingen en richtlijnen
Kort gedefinieerd, een gids is een publicatie die stapsgewijze instructies, tips, gerelateerde concepten biedt. Het kan ook probleemoplossingsinformatie, links naar gerelateerde gemeenschappen, en links naar gerelateerd onderzoek bevatten.
Een leidraad is een overheidsdocument dat bedoeld is om nuttige informatie aan het publiek te verstrekken, zoals het verduidelijken van verplichtingen op grond van een bestaande wet of regeling. Het probeert de complexe juridische taal van bestuursregels te vertalen zodat het publiek zich aan die regels kan houden.
Zie de volledig hoofdstuk over deze soorten technische documentatie.
Handboeken
Kort gedefinieerd is een handboek een omvattende bron die conceptuele informatie (basistheorieën, principes, grondslagen), instructieve informatie (stapsgewijze aanwijzingen) en naslaginformatie (snel op te zoeken informatie) bevat.
Zie de volledig hoofdstuk over dit type technische documentatie.
Instructies
Kort gezegd, vertellen instructies je hoe je dingen bouwt, bedient, repareert—de klassieke "how-to." Voor studenten technisch schrijven, geef de voorkeur aan "Technologie-georiënteerde gebruikershandleidingen."
Zie de volledig hoofdstuk over dit type technische documentatie.
Literatuuroverzichten
Kort gedefinieerd vat een literatuuroverzicht samen wat bekend is over een specifiek onderzoeksonderwerp, beschrijft de mijlpalen in de onderzoeksgeschiedenis, geeft aan waar de huidige kennis met elkaar conflicteert, en bespreekt gebieden waar nog onbekendheden bestaan.
Zie de volledig hoofdstuk over dit type techdoc.
Primaire onderzoeksrapporten (laboratoriumrapporten)
Kort gezegd presenteert een primair onderzoeksrapport bevindingen en interpretatie van laboratorium- of veldonderzoek. Je kunt het zien als een labrapport, maar het is veel meer dan dat.
Zie de volledig hoofdstuk over dit soort technische documentatie.
Voortgangsrapporten
Kort gezegd informeert een voortgangsrapport een leidinggevende, collega of klant over de voortgang van een project gedurende een bepaalde periode. Het project kan het ontwerp, de bouw of de reparatie van iets zijn, het bestuderen of onderzoeken van een probleem of vraag, of het verzamelen van informatie over een technisch onderwerp.
Zie de volledig hoofdstuk over dit type technische documentatie.
Voorstellen
Beknopt gedefinieerd, is een voorstel een aanbod of een bod om een bepaald project voor iemand uit te voeren. Wat een voorstel tot een voorstel maakt, is dat het aan het publiek vraagt om goedkeuring, financiering of toestemming te verlenen om het voorgestelde project uit te voeren.
Zie de volledig hoofdstuk over dit soort technische documentatie.
Aanbeveling, haalbaarheid, evaluatierapporten
Deze groep vergelijkbare rapporten doet dingen zoals meerdere opties vergelijken met een reeks eisen en er één aanbevelen; overweegt een idee (plan, project) in termen van zijn "haalbaarheid,", bijvoorbeeld een combinatie van de technische, economische en sociale praktische uitvoerbaarheid of mogelijkheid; spreekt zich uit over de waarde van iets door het te vergelijken met een reeks eisen (criteria).
Zie de volledig hoofdstuk over deze typen technische documentatie.
Standaard operationele beleidslijnen en procedures
Dit zijn de operationele documenten voor organisaties; ze bevatten regels en voorschriften over hoe van de organisatie en haar leden wordt verwacht dat zij handelen. Beleidsregels en procedures zijn als instructies, maar ze gaan veel verder. Standaard operationele procedures (SOPs) zijn meer bedoeld voor procedures waarin een proces wordt uitgevoerd—bijvoorbeeld het nemen van een tandafdruk.
Zie de Ik zie geen Engelse tekst. Stuur de te vertalen tekst (bijvoorbeeld het volledige hoofdstuk) en ik vertaal het naar het Nederlands. over deze soorten technische documentatie.
Publicatie van een technisch boek
Binnenkort...
Zie de volledig hoofdstuk over dit type technische documentatie.
Technologiegerichte gebruikershandleidingen
Kort gezegd biedt een computergebruikershandleiding technische informatie over het gebruik van computerhardware of -software, inclusief aanwijzingen voor taken zoals installatie, configuratie en essentiële taken.
Zie de volledig hoofdstuk over dit type technische documentatie.
Witboeken
Kort gezegd is een white paper een technologisch of zakelijk document dat achtergrondinformatie biedt over een project (apparaat, methode, enz.) en ervoor pleit. White papers zijn populaire marketinginstrumenten geworden voor bedrijven, vooral op het internet, aangezien veel potentiële klanten op het web naar informatie zoeken. Bedrijven gebruiken white papers om informatie of nieuwe producten te verkopen als oplossingen die tegemoetkomen aan de behoeften van hun klanten.
Zie de volledig hoofdstuk over dit soort technische documentatie.
Gerelateerde informatie
Soorten documenten en hoe je ze gebruikt. Wat te doen
