Si se t’ha encarregat d’escriure un document que suposadament instrueix a algú com fer alguna cosa, la manera actual de fer-ho més o menys llança els mètodes antics per la finestra.
1. Capçaleres bombàstiques grans
Notareu que les capçaleres de PCMech, com ara la que hi ha a sobre d’aquesta frase, són enormes. Això és perquè són més fàcils de veure, llegir i saber on esteu al document.
2. Menys paraules
Sentit contrari:
La següent documentació explica com utilitzar i operar Fanny Whacker 2000.
Manera correcta:
Instruccions sobre com utilitzar Fanny Whacker 2000
Recordeu sempre aquesta frase quan escriviu documentació: VEURE AL PUNT COM A RÀPID COM A POSSIBLE.
3. Eviteu les referències inútils
Si la referència no té res a veure amb la instrucció bàsica del que intenteu descriure, com ara:
Per obtenir més informació sobre el Turnip Twaddler de Fanny Whacker 2000, consulteu el document FU, subapartat ID10T.
… no ho facis.
4. Data-ho. Sempre.
La data en què es va escriure la documentació hauria d’estar a l’àrea de pàgina de pàgina de cada pàgina. Si és un document electrònic, la data es mostra dues vegades. Una vegada al principi, una vegada al final.
Podeu escriure-ho com a "Últim revisat (inseriu la data aquí)".
5. Els avisos sempre s’han de publicar abans del punt de devolució
Si hi ha alguna cosa a la vostra documentació que podria danyar / destruir / eliminar una cosa si es realitza de manera incorrecta, aquesta informació s'ha de posar directament després de la instrucció esmentada, estar a la vista (que significa a la mateixa pàgina) i posar-se en valor.
Exemple:
Pas 5. Netejar el Fanny Whacker 2000
Les paletes del FW2000 s’han de netejar suaument amb un drap suau no abrasiu.
ADVERTIMENT: utilitzeu només dissolvent sense amoníac per evitar que el FW2000 exploti i causi la seva mort prematura.
En una nota final, una bona documentació no prové de ser super-descriptiu sobre qualsevol cosa possible que es pugui imaginar. Llegiu la vostra documentació i pregunteu-vos-la, s’instrueix correctament? Si la resposta és sí, la següent pregunta és: s’instrueix ràpidament ? En cas afirmatiu, la documentació és bona.
