Ja jums ir uzdots uzrakstīt dokumentu, kas it kā kādam citam uzdod, kā kaut ko darīt, šodienas veids, kā to izdarīt, vairāk vai mazāk izmet vecās metodes.
1. Lielas bombastiskas galvenes
Jūs pamanīsit PCMech galvenes, piemēram, tās, kas atrodas virs šī teikuma, ir milzīgas. Tas ir tāpēc, ka viņiem ir vieglāk redzēt, lasīt un zināt, kur atrodaties dokumentā.
2. Mazāk vārdu
Nepareizi:
Šajā dokumentācijā ir paskaidrots, kā lietot un darbināt Fanny Whacker 2000.
Pareizais ceļš:
Norādījumi par to, kā lietot Fanny Whacker 2000
Rakstot dokumentāciju, vienmēr atcerieties šo frāzi: SAŅEMIET PUNKTU ĀTRĀK, KĀ IESPĒJAMS.
3. Izlaist bezjēdzīgas atsauces
Ja atsaucei nav nekā kopīga ar galveno norādījumu tam, ko mēģināt aprakstīt, piemēram:
Lai iegūtu papildinformāciju par Fanny Whacker 2000 rāceņu savācēju, lūdzu, skatiet dokumentu FU, ID10T apakšsadaļa.
… Nedari to.
4. Datums. Vienmēr.
Dokumentācijas rakstīšanas datumam jābūt katras lappuses kājenes laukā. Ja tas ir elektronisks dokuments, datums tiek parādīts divreiz. Vienu reizi sākumā, reizi beigās.
Varat to uzrakstīt kā "Pēdējoreiz pārskatīts (šeit ievietot datumu)".
5. Brīdinājumi vienmēr ir jāizliek pirms atgriešanās vietas
Ja jūsu dokumentācijā ir kaut kas, kas, iespējams, nepareizi izpildot, varētu kaut ko sabojāt / iznīcināt / iznīcināt, šī informācija ir jānovieto tieši pēc minētās instrukcijas, tai jābūt redzamā vietā (tas nozīmē tajā pašā lappusē) un ar akcentiem.
Piemērs:
5. darbība. Fanny Whacker 2000 tīrīšana
FW2000 airi maigi jātīra, izmantojot neabrazīvu mīkstu drāniņu.
BRĪDINĀJUMS: Izmantojiet tikai šķīdinātāju, kas nesatur amonjaku, lai novērstu FW2000 eksploziju un savlaicīgu nāvi.
Noslēgumā jāpiebilst, ka laba dokumentācija nav tā, lai tā būtu ļoti aprakstoša par katru iespējamo lietu. Izlasiet savu dokumentāciju un pajautājiet sev, vai tā rīkojas pareizi? Ja atbilde ir "jā", nākamais jautājums ir, vai tas dod norādījumus ātri ? Ja jā, dokumentācija ir laba.
