Als je de opdracht hebt gekregen om een document te schrijven dat iemand anders moet instrueren hoe je iets moet doen, gooit de manier van vandaag de oude methoden min of meer uit het raam.
1. Grote bombastische koppen
U zult merken dat de headers op PCMech, zoals die direct boven deze zin, enorm zijn. Dit komt omdat ze gemakkelijker te zien, te lezen en te weten zijn waar u zich in het document bevindt.
2. Minder woorden
Verkeerde weg:
De volgende documentatie legt uit hoe de Fanny Whacker 2000 te gebruiken en te bedienen.
Juiste manier:
Instructies voor het gebruik van de Fanny Whacker 2000
Onthoud deze zin altijd wanneer u documentatie schrijft: GA NAAR HET PUNT ZO SNEL MOGELIJK.
3. Sla nutteloze referenties over
Als de verwijzing niets te maken heeft met de kerninstructie van wat u probeert te beschrijven, zoals:
Voor meer informatie over de Turnip Twaddler van Fanny Whacker 2000, zie document FU, paragraaf ID10T.
… doe dat niet.
4. Datum het. Altijd.
De datum waarop de documentatie is geschreven, moet zich in het voettekstgebied van elke pagina bevinden. Als het een elektronisch document is, wordt de datum twee keer getoond. Eens aan het begin, eenmaal aan het einde.
U kunt dit schrijven als "Laatst herzien (vul hier de datum in)".
5. Waarschuwingen moeten altijd worden gepost voordat er geen retour is
Als er iets in uw documentatie staat dat mogelijk schade toebrengt / vernietigt / vernietigt als het onjuist wordt uitgevoerd, moet deze informatie direct na de instructie worden geplaatst, duidelijk zichtbaar zijn (betekenis op dezelfde pagina) en geaccentueerd.
Voorbeeld:
Stap 5. De Fanny Whacker 2000 schoonmaken
De paddles van de FW2000 moeten voorzichtig worden gereinigd met een niet-schurende zachte doek.
WAARSCHUWING: Gebruik alleen ammoniakvrij oplosmiddel om te voorkomen dat de FW2000 explodeert en uw vroegtijdige dood tot gevolg heeft.
Tot slot: goede documentatie is niet superbeschrijvend over elk denkbaar mogelijk ding. Lees uw documentatie en vraag uzelf af of het goed werkt? Als het antwoord ja is, is de volgende vraag: geeft het snel instructies? Zo ja, dan is de documentatie goed.
