ГОССТАНДАРТ РОССИИ - Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА

Данная стратегия предусматривает создание твердых копий документации и диалоговой документации в виде справочных текстов.

В случае изменения данной стратегии следует пересмотреть план документирования.

Вкомплекте документации не предусмотрены инструкции по применению операционной системы, на которой прогоняется система ABC. Однако для читателя должны быть указаны ссылки на соответствующие руководства по данному вопросу.

Инсталляция, ввод в действие и управление документацией системы ABC уже реализованы и не рассматриваются в настоящем проекте.

По умолчанию следует использовать оформление и стиль описания, указанные в ГОСТ Р ИСО/МЭК 15910. Образец страницы приложен к плану документирования.

Таблица С.1 — Руководство по стилю

В аудиторию пользователей данной системы входят операторы компьютеров, обладающие минимальными техническими знаниями. Минимальное образование операторов должно соответствовать 12-летнему среднему (школьному) образованию.

Аудитория не охватывает безграмотных пользователей; все пользователи должны обладать хорошими навыками чтения.

Пользователи должны иметь однолетний (двухлетний) опыт работы в качестве операторов вычислительного центра, включая навыки по эксплуатационным процедурам запуска, остановки, резервирования и сохранения систем, а также загрузки и разгрузки магнитных лент. В их обязанности также должен входить контроль диагностических сообщений от системы и реакция на них.

Предполагается, что пользователи:

a) понимают общие процедуры управления магнитными лентами;

b) обладают адекватным восприятием соответствующих команд операционной системы;

c) не имеют навыков работы с магнитными лентами в системе ABC.

Содержание включает в себя следующее:

a) введение — концепция ABC и ее связь с системой (пять страниц);

b) обзор — общие функции системы ABC (три страницы);

c) установка ленты (пять страниц);

d) снятие ленты (пять страниц);

e) проблемы — руководство по определению дефектов, включая системные сообщения (четыре страницы);

f) словарь терминов и определений (одна страница);

g) указатель (одна страница).

Всего 24 страницы.

По окончании проекта должны быть поставлены следующие объекты:

a) 500 переплетенных копий руководства;

b) электронная копия всей документации на дискетах емкостью 1,44 Мбайт, диаметром 3,5 дюйма в формате DEF 3.0 (пригодная для распечатки документации на принтере);

c) электронная копия справочного текста.

Авторские права на все материалы принадлежат организации XYZ.

Особых условий по транспортированию продукции не требуется.

При создании руководств пользователя системы ABC должны использоваться процедуры разработки и контроля, установленные в Руководстве по качеству организации XYZ.

При производстве руководств пользователя системы ABC следует использовать типографскую систему DEF (версия 3.0). Графические материалы следует разрабатывать с использованием графического пакета JKL.