Често изпълнени с жаргон, акроними и указания, които изискват от Ph.D да разберат, ръководствата за употреба на софтуер понякога се пишат от гледна точка на разработчик, а не на потребител. В резултат на това ръководството може да прави предположения за нивото на уменията на читателя, което често е неправилно. Първата стъпка в написването на добро ръководство за потребителя е да се осъществи процесът на писане колкото е възможно по-далеч от инженерите.
Разработчикът на софтуер знае повече от всеки друг какво прави софтуерът да работи, но това не означава, че разработчикът трябва да напише ръководството. Точно обратното, това е отделен недостатък. По-важно от дълбокото разбиране на вътрешното функциониране на софтуера е разбирането кой ще бъде крайният потребител, какво е образователното му ниво и как този краен потребител ще използва софтуера. В повечето случаи крайните потребители не трябва да знаят по-фините точки на програмиране и работата в края на софтуера - те просто трябва да знаят как да го използват, за да направят работата си по-лесна.
Потребителско тестване
Ръководството за потребителя трябва да бъде до голяма степен ориентирано към задачите, а не да е силно описателно. Тъй като ръководството е написано, за да помогне на потребителите да разберат как да изпълняват конкретни задачи, писателят трябва да има разбиране и за тези задачи, и като резултат, преминаването през всяка отделна стъпка от всяка характеристика е абсолютно необходимо. Не е необходимо писателят задължително да знае как е създадена програмата от гледна точка на дизайна или развитието, но е от съществено значение да имаш силно познаване на всички негови характеристики. Докато изпълнявате всяка задача, отделете време, за да запишете всяка стъпка, включително кликвания, падащи менюта и други действия.
Процесът на интервю
Въпреки че разработчикът не трябва да е този, който да напише наръчника, тя все още ще бъде ценен ресурс за писателя и преди да започне да пише, планирайте среща за среща между писателя, разработчика и инженерите и потенциалните крайни потребители, за да информирате писателска работа от самото начало. Трябва да се запишат интервюта с експерти по тематика и инженери, с преписи, направени за по-късна справка.
образи
Ръководството за потребителя не трябва да е твърде тежко. Вместо това включвайте либерално използване на графики и екранни клипове. Описание на дадено действие е много по-ясно с текстови насоки, придружени от клип, който ясно илюстрира тази посока. Включете както преди, така и след изгледи, за да покажете как изглежда екранът, преди да предприемете всяко действие, и какво се случва след предприемането на действието. Една проста помощна програма за улавяне на екрана, като например инструмента за изрязване, включен в Microsoft Windows, работи добре за заснемането на тези изображения. Уверете се, че сте маркирали всяко изображение и включете надпис, който го описва накратко. Центрирайте го непосредствено под параграфа, който първо въвежда концепцията, изобразена на изображението.
форматиране
Ясното комуникиране в технически документ изисква планиране и внимателно спазване на стандартите в цялото ръководство. Стандартите в представянето, езика и номенклатурата помагат да се избегне объркване. Предлагат се шаблони и могат да бъдат добра отправна точка за еднаквост, въпреки че те със сигурност могат да бъдат адаптирани, за да отговарят на всяка ситуация. Използването на един-инчов марж с една колона най-добре отговаря на необходимостта от добавяне на графики; настройката с две колони може да изглежда прекалено претъпкана и може да направи поставянето на изображения объркващо.
Версии и проследяване
Повече от всеки друг вид документ, софтуерното ръководство за потребителя вероятно ще премине през многократни повторения, преди да е завършено, и вероятно ще премине през процес на преглед от множество заинтересовани страни. Използването на функцията за проследяване на промените в Microsoft Word е лесен начин да следите коментарите и промените на всеки човек. Създаването на няколко версии след всеки цикъл на преглед, всеки с различно име на файл, също помага на процеса и гарантира, че всички заинтересовани страни са доволни от крайния резултат.
