СТ РК 1087-2002
Единая система программной документации
Руководство пользователя
Требования к составу, содержанию и оформлению
Содержание
1. Область применения
2. Нормативные ссылки
3. Определения
4. Требования к документам, входящим в руководство пользователя
1. Область применения
Настоящий стандарт распространяется на документацию, которой руководствуется пользователь при инсталляции, эксплуатации и управлении программным обеспечением и включает те аспекты сопровождения программного обеспечения, которые не требуют модификации исходного кода.
Настоящий стандарт устанавливает и определяет минимальные требования к структуре и содержанию руководства пользователя.
Данный стандарт применим только к документации, напечатанной на бумаге или хранимой на другом носителе информации в формате печатного документа и используемой по аналогии со способами использования печатного документа.
2. Нормативные ссылки
В настоящем стандарте использованы ссылки на следующие нормативные документы:
СТ РК 1091-2002 Единая система программной документации. Термины и определения.
ГОСТ 19.104-78 Единая система программной документации. Основные надписи.
3. Определения
В настоящем стандарте применяются термины и определения в соответствии с СТ РК 1091-2002.
4. Требования к документам, входящим в руководство пользователя
4.1 Определение требуемых документов пользователя
При определении требуемых документов пользователя должны быть определены: программный продукт, область его применения и категория пользователей. Затем определяется набор документов для конкретной категории пользователей и способ использования каждого документа.
4.1.1 Идентификация программного обеспечения. На начальном этапе планирования документации должны быть определены программное обеспечение, его интерфейсы с пользователем и задачи, которые пользователь может решать с помощью этого программного обеспечения.
4.1.2 Определение категории пользователя. Документация пользователя программного обеспечения должна быть ориентирована на конкретную категорию пользователей. При подготовке документов пользователя должны быть учтены различные способы работы с документацией: например, частота обращения к документации, уровень обращения, прямое или косвенное обращение.
Категории пользователей программным обеспечением подразделяется на следующие группы:
- случайные пользователи, взаимодействие которых с программным обеспечением не обусловлено их служебными обязанностями;
- параметрические пользователи, которые работают с программным обеспечением повседневно с четко определенной областью деятельности, по регламентированным процедурам;
- аналитики и исследователи, информационные потребности которых непредсказуемы (в отличие от параметрических пользователей);
- прикладные программисты, которые разрабатывают в основном программное обеспечение для параметрических пользователей;
