Калі вам даручылі напісаць дакумент, які павінен навучыць кагосьці іншага зрабіць, сённяшні спосаб зрабіць гэта больш-менш выкідвае старыя метады ў акно.

1. Вялікія выбухныя загалоўкі

Вы заўважыце, што загалоўкі ў PCMech, напрыклад, прама над гэтай прапановай, велізарныя. Гэта таму, што іх лягчэй бачыць, чытаць і ведаць, дзе вы знаходзіцеся ў дакуменце.

2. Менш слоў

Няправільны шлях:

Наступная дакументацыя тлумачыць, як выкарыстоўваць і кіраваць Fanny Whacker 2000.

Правільны шлях:

Інструкцыя па выкарыстанні Fanny Whacker 2000

Заўсёды памятайце гэтую фразу, калі пішаце дакументацыю: ПРАВЯДЖАЙЦЕ МЯСТА БЫСТРЭСКІМ, МОЖНА.

3. Прапусціце бескарысныя спасылкі

Калі спасылка не мае нічога агульнага з асноўнай інструкцыяй таго, што вы спрабуеце апісаць, напрыклад:

Больш падрабязную інфармацыю аб рэпарышчы мядзведзяў Fanny Whacker 2000, калі ласка, глядзіце ў дакуменце FU, падраздзел ID10T.

... не рабі гэтага.

4. Даце яго. Заўсёды.

Дата напісання дакументацыі павінна быць у галіне ніжняга калантытула кожнай старонкі. Калі гэта электронны дакумент, дата паказваецца двойчы. Раз у пачатку, раз у канцы.

Вы можаце напісаць гэта як "Апошні раз перагледжаны (устаўце дату тут").

5. Папярэджанні заўсёды павінны быць размешчаны перад кропкай адказу

Калі ў вашай дакументацыі ёсць нешта, што патэнцыйна можа пашкодзіць / знішчыць / знішчыць што-небудзь пры няправільнай працы, гэтая інфармацыя павінна быць размешчана непасрэдна пасля дадзенай інструкцыі, быць у поле зроку (гэта значыць на той жа старонцы) і з акцэнтам.

Прыклад:

Крок 5. Чыстка Fanny Whacker 2000 Вясло FW2000 трэба акуратна чысціць, выкарыстоўваючы неабразіўную мяккую тканіну. УВАГА: Выкарыстоўвайце растваральнік толькі без аміяку, каб прадухіліць выбух FW2000 і прывесці да вашай заўчаснай гібелі.

Нарэшце, добрая дакументацыя - не надта апісальная інфармацыя пра кожную магчымую рэч, якую можна ўявіць. Прачытайце сваю дакументацыю і спытайцеся ў сябе, ці правільна яна інструкцыя? Калі адказ - так, наступнае пытанне - ці правільна гэта інструктаваць? Калі так, дакументацыя добрая.