Notities:
• De hoofdstukken in dit leerboek zijn vertaald met behulp van OpenAI en kunnen fouten bevatten. Als je problemen vindt met de vertalingen, stuur dan correcties naar de auteur op admin@mcmassociates.io.
• Als je hier verouderde of onnauwkeurige technologie vindt, ben je ook welkom om correcties te sturen. Vergeet echter niet dat dit een boek is over technische documentatie, geen technologiehandleiding—oudere technologieën kunnen nog steeds nuttige voorbeelden bieden.
• Doneer om te blijven Online Technisch Schrijfboek vrij.
• Terwijl je hier bent, stuur David een vriendelijke hello-e-mail: admin@mcmassociates.io
Een grote verandering heeft plaatsgevonden in dit online technische schrijversboek: het gebruikt nu technisch document (technische documentatie voor het kort) om te verwijzen naar elk document dat technische informatie bevat — in plaats van het gebruik van verslag. Het rapport is een subcategorie samen met de andere soorten technische documenten die in dit boek worden besproken.
Inleiding: Technisch Schrijven
- Wat is er nieuw?
- Over technisch schrijven
- Over cursussen technisch schrijven
- Hulpbronnen
- Over de auteur
- Erkenningen
- Links naar naslagwerken
Toepassingen van Technisch Schrijven
Opmerking: Dit online leerboek gebruikt nu technisch document, of gewoon technische documentatie, in gevallen waarin rapport is te specifiek. (VN-emblemen) geven aan dat vertalingen beschikbaar zijn als je de link volgt.
- Enquête over technische documentatie
- Zakelijke en werkdocumenten:
- Gegevensrapporten
- Bedrijfsplannen
- Voorstellen
- Aanbevelings- en haalbaarheidsrapporten
- Witboeken
- Voortgangsrapporten
- Instructies
- Achtergrondrapporten
- Ingenieursontwerprapport
- Technologiegerichte gebruikershandleidingen
- Specificaties en datasheets
- Releasedocumenten
- Toepassingsgevallen, casestudy's
- Standaard operationele beleidslijnen en procedures
- Primaire onderzoeksrapporten. Voor laboratorium en veld.
- Literatuuronderzoeken
- Gidsen en richtlijn documenten
- Handboeken
- Voor- en achterwerk:
Informatiestructuren
Informatiestructuren worden gebruikt als onderdelen van langere documenten, maar kunnen ook als documenten op zich worden gebruikt, vooral voor technische schrijfprojecten. Deze informatiestructuren zijn een goede plek om te beginnen voor mensen in ontwikkelingsgericht technisch schrijven.
Documentontwerp
- Techdoc ontwerp overzicht
- Boekontwerp overzicht
- Pagina ontwerpoverzicht
- Koppen
- Lijsten
- Bijzondere mededelingen
- Niet-tekstuele elementen: tabellen, figuren, grafieken
- Techdoc-indeling en uiteindelijke verpakking
- Markering en nadruk
- Indexeren
Processen en richtlijnen in technisch schrijven
- Schrijfvproces: van publiek naar ruwe versie
- Doelgroepanalyse
- Taakanalyse
- Technische informatie vertalen
- Power-revisietechnieken
- Informatie Verwerking
- Informatie verzamelen (NoodleTools of Notebook LM)
- Citaten, Parafrasen, Samenvattingen: Formulering, Interpunctie, Toeschrijving
- Basispatronen en elementen van de zin
- Veelvoorkomende grammatica-, gebruiks- en interpunctieproblemen
- Veelvoorkomende spelfouten
- Strategieën voor peer-reviewen en teamschrijven
