Het schrijven van documentatie is belangrijke, maar technische documentatie is meer dan schrijven alleen. Denk ook na over onderstaande punten. Kom je er niet uit dan help ik je graag.
- Voldoen aan richtlijnen en normen: Denk aan regelgeving zoals CE-richtlijnen en normen zoals ISO 7000.
- Documentatie voor de volledige product life cycle: Van ontwikkeling en installatie tot onderhoud en einde levensduur: alle benodigde documentatie moet beschikbaar zijn.
- Scheiding tussen documentatie en training: Bepaal welke informatie thuishoort in documentatie en welke beter geschikt is voor training. Voorkom dubbele informatie door documentatie slim te hergebruiken in trainingen.
- Consistente huisstijl: Een professionele uitstraling vraagt om duidelijke richtlijnen, goede templates en consistente aanduidingen in afbeeldingen en schema’s.