Schrijven van (technische) documentatie
In deze training leer je om technische documenten goed op te stellen. In de praktijk zien we namelijk vaak dat er ruis en daardoor vertraging ontstaat doordat er onduidelijk gedocumenteerd wordt. Na deze training ben je in staat om op een duidelijke en efficiënte manier documenten op te stellen. Je leert onder andere:
Waarom maak je documentatie
Wat zijn de uitgangspunten voor technische documentatie?
Instructies schrijven
Hete hangijzers bij technisch documenteren
Samenwerken bij schrijven van documentatie
Andere manieren van informatie delen
Een stijlgids maken
Lezervriendelijk formuleren
De training is geschikt voor iedereen die te maken heeft met het schrijven van technische documenten. Zowel voor intern als extern gebruik.
Geen voorkennis benodigd
Waarom maak je documentatie?
- Het belang van goede (technische) documenten
- Doelgroepen voor technische documentatie
- Leerdoelen (weten, keuzes kunnen maken, doen)
Wat zijn de uitgangspunten voor technische documentatie?
- Opdelen in topics
- Alleen relevante informatie
- taakgericht beschrijven
- herhaling vermijden
- links naar gerelateerde onderwerpen
Hete hangijzers bij technisch documenteren
- Mutaties, afhankelijkheden, versiebeheer
Samenwerken bij schrijven van documentatie
- Meelezen
- Inbreng van gebruikers
Andere manieren van informatie delen
- Scenario’s
- Bloggen
Een stijlgids makenLezervriendelijk formuleren