Колкото и гениален да е изобретателят, програмистът или рационализаторът, понякога неговите творения просто не могат да бъдат използвани по предназначение. Причината за това е неправилно съставеното ръководство с инструкции или пълното му отсъствие. Но дори гениални изобретатели понякога пишат такива инструкции, че освен тесни специалисти, никой не може да прочете тези документи. И така, как правилно да съставите такъв необходим документ?
Необходимо е
- - сто процента познания за устройството или софтуерния продукт, за който е написано ръководството;
- - знания в областта на лингвистиката;
- - писмени умения.
Инструкции
Етап 1
Ръководство за потребителя или, с други думи, ръководство за експлоатация е документ, предназначен да предостави помощ при използването на определена система на своите потребители. За да съставите ръководство за потребителя, трябва да знаете описаната система на сто процента, но да я погледнете през очите на невеж студент. Да предположим, че е написано ръководство на потребителя за софтуерна програма, която все още няма аналози. Представете си, че за първи път използвате тази програма. Откъде да започнете? Какво е първото нещо, което трябва да знаете? Организирайте тези знания в важни категории.
Стъпка 2
Разделяйки цялата информация относно вашето творение на групи, вие изготвихте план за написване на ръководство за потребителя. Започнете да описвате работата във вашата програма от нулата, оставяйки накрая най-трудните детайли, като например функции за препрограмиране или справяне с критични грешки. На този етап трябва да сте подготвили съдържанието на ръководството за потребителя - една от задължителните части на този документ.
Стъпка 3
Ако ръководството, което създавате, е предназначено за използване в голяма компания, тогава трябва да обърнете внимание на приетите там корпоративни стандарти. Например в много руски компании ръководствата за потребителя не се приемат без илюстративна поддръжка, с други думи, снимки, които обясняват написаното. В допълнение към съдържанието, ръководството за потребителя трябва да съдържа и други задължителни части: - Анотация, т.е. обяснение на общите цели на ръководството и описания продукт; - въведение, което описва документите, свързани с ръководството за потребителя и как да използвате ръководството; - раздели, обясняващи използването на продукта на различни етапи от неговото използване, например, първи стъпки, ремонт или поддръжка; - раздел на често задавани въпроси и отговори на тях; - речник или тематичен указател.
Стъпка 4
Обикновено в създаването на ръководство за потребител участва технически писател - човек, който притежава всички необходими знания както на езика, така и на продукта, който се описва. Като технически писател без обучение има няколко правила, които трябва да имате предвид. Първо, не трябва да злоупотребявате със специални термини, които не са разбираеми за обикновен потребител. Второ, всеки използван термин трябва да бъде подробно и обяснен. На трето място, трябва да пишете възможно най-ясно и кратко. И накрая, един технически писател трябва да може да гледа собствения си текст през очите на обикновен потребител, за да види недостатъците на собствения си текст.
Стъпка 5
Добре е да тествате на практика готовия текст на ръководството за потребителя, като го предлагате на човек, който няма нищо общо с описания продукт. Чрез съвместни усилия е възможно да се отстранят всички недостатъци и клопки на документа.
