3 Применение специальной функциональной клавиши в документации должно быть соотнесено с использованием функциональных клавиш в самом программном приложении.
ПРИЛОЖЕНИЕ А (справочное)
Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207
Настоящий стандарт соответствует ГОСТ Р ИСО/МЭК 12207 в части реализации его подраздела 6.1 по отношению к документации пользователя (см. таблицу А.1).
Таблица А.1 — Перекрестные ссылки с ГОСТ Р ИСО/МЭК 12207
| Пункты ГОСТ Р ИСО/МЭК 12207 | Пункты настоящего стандарта |
|---|---|
| 6.1.1.1 | 8.1.3 План документирования |
| 6.1.2.1 | 8.2 Содержание спецификации стиля |
| 6.1.2.2 | 8.1.2 Представление исходных материалов |
| 6.1.2.3 | 8.1.4 Проверка (анализ) |
| 6.1.3.1 | 8.2 Содержание спецификации стиля. 8.1.3 План документирования |
| 6.1.3.2 | 8.1.3.3 Проверка плана документирования |
| 6.1.4.1 | 8.1.7 Контроль изменений и сопровождение документации |
ПРИЛОЖЕНИЕ В (справочное)
Использование настоящего стандарта в договоре
B.1 Общие положения
В настоящем стандарте имеются разделы, требования которых необходимо пояснить применительно к конкретному договору или другим ссылочным документам (например, международным). В свою очередь, план документирования также нуждается в пояснении. В договоре должны быть даны ответы на следующие вопросы:
a) откуда поступает информация о изучении аудитории? (Ответ рекомендуемый);
b) необходимо ли готовить более двух проектов комплекта документации и одного комплекта гранок?
(При необходимости, в настоящем стандарте по умолчанию предусмотрены два проекта комплектов документации и один комплект гранок);
c) кто представляет исходные материалы? (Обычно это очевидно, но для проектов со сложными взаимосвязями между вовлеченными сторонами нуждается в уточнении);
d) какие уровни конфиденциальности или секретности необходимо использовать для материалов, предоставляемых заказчиком документатору?
e) имеется ли стандарт на оформление бумажной документации? (Это не обязательно; по умолчанию может быть использована спецификация стиля документации, установленная в настоящем стандарте; затем в плане документирования может быть оговорено количество проектов документации и т. д.).
B.2 Образец раздела договора
В соответствии с настоящим стандартом образец раздела договора может быть представлен в следующем виде.
Пример
Раздел 123 Документация
Вся документация пользователя должна соответствовать ГОСТ Р ИСО/МЭК 15910.
В комплект документации не следует включать диалоговую документацию и справочные тексты. Вся информация об изучении аудитории и другие исходные материалы должны представляться заказчиком.
Должно быть проведено одно тестирование на практичность при поставке первого модуля программного средства, которое должно предусматривать проверки всех функциональных возможностей данного модуля в интересах пяти различных типовых пользователей.
В.З Практическое применение настоящего стандарта
Необходима адаптация настоящего стандарта в интересах потребителей и пользователей в целях его практического применения.
Практическое применение настоящего стандарта обычно заключается в исключении и добавлении ряда разделов, что должно быть оговорено соответствующим соглашением (как правило, в договоре, но возможно и в плане документирования).
Практическое применение настоящего стандарта следует проводить тщательно, с учетом его общей структуры.
ПРИЛОЖЕНИЕ С (справочное)
Образец плана документирования. Документация пользователя для системы ABC — административного управления магнитными лентами
С.1 Введение
В настоящем плане описана стратегия разработки документации пользователя для системы ABC, представляемой в виде комплекта документации XYZ. Определена область применения проекта, номенклатура поставки документации и ресурсы, необходимые для ее создания.
Данная стратегия предусматривает создание твердых копий документации и диалоговой документации в виде справочных текстов.
В случае изменения данной стратегии следует пересмотреть план документирования.
С.2 Область применения и ограничения
В комплекте документации не предусмотрены инструкции по применению операционной системы, на которой прогоняется система ABC. Однако для читателя должны быть указаны ссылки на соответствующие руководства по данному вопросу.
Инсталляция, ввод в действие и управление документацией системы ABC уже реализованы и не рассматриваются в настоящем проекте.
С.З Оформление и стиль описания
По умолчанию следует использовать оформление и стиль описания, указанные в ГОСТ Р ИСО/МЭК 15910. Образец страницы приложен к плану документирования.
Таблица С.1 — Руководство по стилю
| Элемент | Значение |
|---|---|
| Содержание справочного текста | Должен быть описан только контекст справки |
| Содержание диалоговой документации | Отсутствует |
| Сопутствующие материалы | Справочный текст для каждого объекта должен быть представлен на одном экране |
| Засветки и использование цветов | В справочном тексте не следует использовать цвета и другие засветки |
| Оформление диалоговой документации и справочного текста | Должен быть использован одноколонный формат |
| Оформление заголовков диалоговой документации и справочного текста | Вверху каждой страницы справочного текста должен быть проставлен заголовок первого уровня: кегль 14 п, гарнитура Times Roman |
| Оформление основной части документа | Текст должен быть выровнен по левому краю и набран одним шрифтом |
| Правила навигации | В соответствии со справочным механизмом системы ABC |
| Использование клавиатуры | В соответствии со стандартами на систему ABC |
С.4 Аудитория
В аудиторию пользователей данной системы входят операторы компьютеров, обладающие минимальными техническими знаниями. Минимальное образование операторов должно соответствовать 12-летнему среднему (школьному) образованию.
Аудитория не охватывает безграмотных пользователей; все пользователи должны обладать хорошими навыками чтения.
Пользователи должны иметь однолетний (двухлетний) опыт работы в качестве операторов вычислительного центра, включая навыки по эксплуатационным процедурам запуска, остановки, резервирования и сохранения систем, а также загрузки и разгрузки магнитных лент. В их обязанности также должен входить контроль диагностических сообщений от системы и реакция на них.
Предполагается, что пользователи:
a) понимают общие процедуры управления магнитными лентами;