Документація користувача - студопедія
Документація користувача (user documentation): повний комплект документів, що поставляються в друкованому або іншому вигляді, який забезпечує застосування продукту, а також є його невід'ємною частиною.
Документація користувача повинна відповідати наступним характеристикам.
Повнота (completeness). Документація користувача повинна містити інформацію, необхідну для використання продукту. У ній повинні бути повністю описані всі функції, встановлені в описі продукту, і все що викликаються користувачем функції з програми. Крім того, граничні значення, задані в описі продукту, повинні бути продубльовані в документації користувача. Якщо установка (інсталяція) продукту може бути проведена користувачем, то в документацію користувача повинно бути включено керівництво по установці продукту, що містить всю необхідну інформацію. Якщо супровід продукту може проводитися користувачем, то в документацію користувача повинно бути включено керівництво по супроводу програми, що містить всю інформацію, яка необхідна для забезпечення даного виду супроводу.
Правильність (correctness). Вся інформація в документації користувача повинна бути правильною. Крім того, уявлення даної інформації не повинно містити неоднозначних тлумачень і помилок.
Несуперечливість (consistency). Документи, що входять в комплект документації користувача, не повинні суперечити самі собі, один одному і опису продукту. Кожен термін повинен мати один і той же сенс у всіх документах.
Зрозумілість (understandability). Документація користувача повинна бути зрозумілою для спільноти користувачів, що виконують зазначену робочу задачу, наприклад, за допомогою використання в ній відповідним чином підібраних термінів, графічних вставок, уточнюючих пояснень і шляхом посилань на корисні джерела інформації.
Простота огляду (ease of overview). Документація користувача повинна бути досить проста для вивчення користувачем, щоб він міг виявити всі описувані в ній взаємозв'язку компонентів продукту. У кожен документ можуть бути включені зміст і предметний покажчик.
Резюмуючи, скажімо, що виникла нагальна потреба у введенні в вітчизняні стандарти на документування ПС тих норм, правил, вимог і рекомендацій, які встановлені на міжнародному і передовому зарубіжному рівнях. Але при проведенні цих робіт не можна обмежуватися прямим перекладом окремих міжнародних стандартів. Потрібно, щоб нові стандарти правильно стикувалися з усім наявним і майбутнім безліччю нормативних документів.