Ако сте били натоварени с писането на документ, който трябва да инструктира някой друг как да направи нещо, днешният начин да го направите повече или по-малко хвърля старите методи през прозореца.
1. Големи бомбастични хедъри
Ще забележите, че заглавките на PCMech, като тази вдясно над това изречение, са огромни. Това е така, защото те по-лесно виждат, четат и знаят къде се намирате в документа.
2. По-малко думи
Грешен начин:
Следващата документация обяснява как да използвате и управлявате Fanny Whacker 2000.
Правилния начин:
Инструкции как да използвате Fanny Whacker 2000
Винаги помнете тази фраза, когато пишете документация: ВЗЕМЕТЕ НА ТОЧКАТА КАТО БЪРЗО КАТО ВЪЗМОЖНО.
3. Пропуснете безполезни препратки
Ако препратката няма нищо общо с основната инструкция на това, което се опитвате да опишете, като например:
За допълнителна информация относно Turnip Twaddler на Fanny Whacker 2000, моля, вижте документ FU, подраздел ID10T.
… Не правете това.
4. Датирайте го. Винаги.
Датата, на която е написана документацията, трябва да бъде в областта на долния колонтитул на всяка страница. Ако става въпрос за електронен документ, датата се показва два пъти. Веднъж в началото, веднъж в края.
Можете да напишете това като „Последно преработено (въведете дата тук)“.
5. Предупрежденията трябва винаги да се публикуват преди момента на връщане
Ако във вашата документация има нещо, което потенциално би могло да повреди / унищожи / заличи нещо, ако се изпълни неправилно, тази информация трябва да бъде поставена директно след посочената инструкция, да бъде в полезрението (което означава на същата страница) и да се акцентира.
Пример:
Стъпка 5. Почистване на Fanny Whacker 2000
Греблата на FW2000 трябва да се почистват внимателно с неабразивна мека кърпа.
ВНИМАНИЕ: Използвайте само разтворител без амоняк, за да предотвратите избухването на FW2000 и да доведе до вашата ненавременна смърт.
В заключение, добрата документация не е от суперописателна информация за всяко възможно нещо, което може да се представи. Прочетете документацията си и се запитайте, инструкции ли правилно? Ако отговорът е „да“, следващият въпрос е, дали инструктира бързо ? Ако да, документацията е добра.
