С.1 Введение
В настоящем плане описана стратегия разработки документации пользователя для системы ABC, представляемой в виде комплекта документации XYZ. Определена область применения проекта, номенклатура поставки документации и ресурсы, необходимые для ее создания.
Данная стратегия предусматривает создание твердых копий документации и диалоговой документации в виде справочных текстов.
В случае изменения данной стратегии следует пересмотреть план документирования.
С.2 Область применения и ограничения
В комплекте документации не предусмотрены инструкции по применению операционной системы, на которой прогоняется система ABC. Однако для читателя должны быть указаны ссылки на соответствующие руководства по данному вопросу.
Инсталляция, ввод в действие и управление документацией системы ABC уже реализованы и не рассматриваются в настоящем проекте.
С.З Оформление и стиль описания
По умолчанию следует использовать оформление и стиль описания, указанные в ГОСТ Р ИСО/МЭК 15910. Образец страницы приложен к плану документирования.
Таблица С.1 — Руководство по стилю
| Элемент | Значение |
|---|---|
| Содержание справочного текста | Должен быть описан только контекст справки |
| Содержание диалоговой документации | Отсутствует |
| Сопутствующие материалы | Справочный текст для каждого объекта должен быть представлен на одном экране |
| Засветки и использование цветов | В справочном тексте не следует использовать цвета и другие засветки |
| Оформление диалоговой документации и справочного текста | Должен быть использован одноколонный формат |
| Оформление заголовков диалоговой документации и справочного текста | Вверху каждой страницы справочного текста должен быть проставлен заголовок первого уровня: кегль 14 п, гарнитура Times Roman |
| Оформление основной части документа | Текст должен быть выровнен по левому краю и набран одним шрифтом |
| Правила навигации | В соответствии со справочным механизмом системы ABC |
| Использование клавиатуры | В соответствии со стандартами на систему ABC |
С.4 Аудитория
В аудиторию пользователей данной системы входят операторы компьютеров, обладающие минимальными техническими знаниями. Минимальное образование операторов должно соответствовать 12- летнему среднему (школьному) образованию.
Аудитория не охватывает безграмотных пользователей; все пользователи должны обладать хорошими навыками чтения.
Пользователи должны иметь однолетний (двухлетний) опыт работы в качестве операторов вычислительного центра, включая навыки по эксплуатационным процедурам запуска, остановки, резервирования и сохранения систем, а также загрузки и разгрузки магнитных лент. В их обязанности также должен входить контроль диагностических сообщений от системы и реакция на них.
Предполагается, что пользователи:
a) понимают общие процедуры управления магнитными лентами;
b) обладают адекватным восприятием соответствующих команд операционной системы;
c) не имеют навыков работы с магнитными лентами в системе ABC.
С.5 Проект содержания документации
Содержание включает в себя следующее:
a) введение — концепция ABC и ее связь с системой (пять страниц);
b) обзор — общие функции системы ABC (три страницы);
c) установка ленты (пять страниц);
