Как да напишете ръководството за потребителя на програма
Стъпка 1
Напишете схема на ръководството. Това ще ви даде план да го следвате. Точките, които трябва да включите в схемата, са инсталационният процес, приложенията на програмата, описанията на менютата, общите задачи, разширените функции и секцията за отстраняване на неизправности. Той също така включва подраздели в дизайна ви за конкретни задачи, като създаване на нов файл, записване и отпечатване на файлове.
Стъпка 2
Той подробно описва процеса на инсталиране, включително изискванията на компютъра. Тя осигурява изискванията преди основната инсталация, така че потребителите да могат да подготвят своя компютър. Той описва дори най-основните стъпки за начинаещи компютър. Тези стъпки могат да бъдат "двукратно върху инсталационния файл" или "вмъкнете компактдиска в CD ROM устройството". Типичните стъпки на инсталация включват обясняване на опциите за инсталиране, като например типична инсталация, за разлика от разширена инсталация, като потребителят стъпка по стъпка преминава през всеки екран на IGU (Graphical User Interface), с който се намира, като регистрира и въведете кодове или серийни номера и как да получите достъп до програмата след инсталирането, за да проверите дали инсталацията е правилна.
Стъпка 3
Подробно описание на приложенията на програмата. Включва това, за което е необходима програмата и как можете да се възползвате от нея. Например, ако програмата се занимава със счетоводство, тя обяснява как да се опростят нормалните счетоводни задачи. Изяснява кои са най-важните функции за крайния потребител. Това ще даде на потребителя представа кои функции първо ще се опитат да научат. Например, в програма за създаване на музика, кажете на потребителя колко песни той може да записва едновременно, всички звуци и ритми, които той има и в какви формати той може да запази файловете. Тя включва кратко описание на разширените функции, което го прави различна от другите на пазара. Например програмата ви може да генерира повече отчети или да поддържа повече типове файлове, отколкото която и да е друга програма, налична в момента.
Стъпка 4
Обяснява как да се придвижвате в менютата. Обяснете всяка точка от наличните менюта. Нещо, което не може да бъде обяснено в едно или две изречения, трябва да бъде включено в раздела "Общи задачи" в ръководството. Тези задачи могат да включват промяна на шрифта и цветовете, как да отпечатвате различни формати и типове файлове и как да организирате файлове и информация.
Стъпка 5
Напишете отделен раздел за разширени функции и допълнителни функции. Това е мястото, където трябва да влезете в подробности. Например, ръководството на потребителя за Microsoft Excel ще включва информация за това как да създавате отчети, връзки и макроси. Допълнителните функции ще включват функции, които потребителят може да не чака. Например, програма за създаване на музика може да донесе вграден музикален плейър. Отделете време, за да обясните всички допълнителни неща, които идват с вашата програма, или уникалните приложения от нея.
Стъпка 6
Включва предложения за решаване на проблеми. Обяснява значението на всяка грешка, която потребителят може да открие, как да реши проблема и как да го предотврати в бъдеще. Това е и мястото, където трябва да включите информация за контакт и информация за обслужване на клиенти.
