Se sei stato incaricato di scrivere un documento che dovrebbe istruire qualcun altro su come fare qualcosa, il modo in cui oggi lo fa più o meno getta i vecchi metodi fuori dalla finestra.
1. Grandi intestazioni bombastiche
Noterai che le intestazioni su PCMech, come quella sopra questa frase, sono enormi. Questo perché sono più facili da vedere, leggere e sapere dove ti trovi nel documento.
2. Meno parole
Senso vietato:
La seguente documentazione spiega come utilizzare e utilizzare Fanny Whacker 2000.
Modo giusto:
Istruzioni su come usare Fanny Whacker 2000
Ricorda sempre questa frase quando scrivi la documentazione: RAGGIUNGI AL PUNTO PIÙ VELOCEMENTE POSSIBILE.
3. Salta riferimenti inutili
Se il riferimento non ha nulla a che fare con l'istruzione principale di ciò che stai tentando di descrivere, come ad esempio:
Per ulteriori informazioni su Turnip Twaddler di Fanny Whacker 2000, consultare il documento FU, sottosezione ID10T.
… non farlo.
4. Data. Sempre.
La data in cui la documentazione è stata scritta dovrebbe essere nell'area del piè di pagina di ogni pagina. Se si tratta di un documento elettronico, la data viene visualizzata due volte. Una volta all'inizio, una volta alla fine.
Puoi scrivere questo come "Ultima revisione (inserire la data qui)".
5. Gli avvisi devono essere sempre inviati prima del punto di non ritorno
Se c'è qualcosa nella tua documentazione che potrebbe potenzialmente danneggiare / distruggere / cancellare qualcosa se eseguito in modo errato, queste informazioni dovrebbero essere inserite direttamente dopo detta istruzione, essere in bella vista (cioè sulla stessa pagina) e accentate.
Esempio:
Passaggio 5. Pulizia di Fanny Whacker 2000
Le piastre dell'FW2000 devono essere pulite delicatamente con un panno morbido non abrasivo.
AVVERTENZA: utilizzare solo solventi privi di ammoniaca per prevenire l'esplosione dell'FW2000 e la morte prematura.
In ultima analisi, una buona documentazione non deriva dall'essere super descrittiva su ogni singola cosa possibile immaginabile. Leggi la tua documentazione e chiediti, ti istruisce correttamente? Se la risposta è sì, la domanda successiva è: istruisce rapidamente ? Se sì, la documentazione è buona.
