Ако сте били оптужени за писање документа који би требао некога другог упутити како нешто учинити, данашњи начин да се то учини мање или више баца старе методе кроз прозор.
1. Велика бомбастична заглавља
Примјетићете да су заглавља на ПЦМецх-у, попут оне десно изнад ове реченице, огромна. То је зато што их је лакше видјети, прочитати и знати гдје се налазите у документу.
2. Мање речи
Погрешан начин:
Следећа документација објашњава како се користи и користи Фанни Вхацкер 2000.
Прави начин:
Упутство за употребу Фанни Вхацкер 2000
Увек запамтите ову фразу док пишете документацију: ДОђите до ТОЧКА КАО БРЗО КАО МОГУЋЕ.
3. Прескочите бескорисне референце
Ако референца нема никакве везе са основним упутством онога што покушавате да опишете, као што су:
За додатне информације о Турнип Тваддлер компаније Фанни Вхацкер 2000, погледајте документ ФУ, пододељак ИД10Т.
… не ради то.
4. Датуми. Увек.
Датум када је документација написана треба да буде у подножју подножја сваке странице. Ако се ради о електронском документу, датум се приказује два пута. Једном на почетку, једном на крају.
Ово можете написати као „Последњи пут ревидиран (овде унесите датум)“.
5. Упозорења увек треба постављати пре тачке у којој нема повратка
Ако у вашој документацији постоји нешто што би могло оштетити / уништити / обрисати нешто ако се изврши погрешно, ове информације треба да буду постављене директно након поменутог упутства, да буду видљиве (значи на истој страници) и са нагласком.
Пример:
Корак 5. Чишћење Фанни Вхацкер 2000
Весла ФВ2000 треба пажљиво очистити неабразивном меком крпом.
УПОЗОРЕЊЕ: Користите само растварач без амонијака да спречите ФВ2000 да експлодира и што резултира вашом превременом смрћу.
На крају, добра документација није од супер описивања сваке могуће ствари. Прочитајте своју документацију и запитајте се да ли је то правилно? Ако је одговор потврдан, следеће питање је да ли то даје упутства брзо ? Ако је одговор да, документација је добра.
