В.З Практическое применение настоящего стандарта
Необходима адаптация настоящего стандарта в интересах потребителей и пользователей в целях его практического применения.
Практическое применение настоящего стандарта обычно заключается в исключении и добавлении ряда разделов, что должно быть оговорено соответствующим соглашением (как правило, в договоре, но возможно и в плане документирования).
Практическое применение настоящего стандарта следует проводить тщательно, с учетом его общей структуры.
ПРИЛОЖЕНИЕ С (справочное)
Образец плана документирования. Документация пользователя для системы ABC — административного управления магнитными лентами
С.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) установка ленты (пять страниц);
d) снятие ленты (пять страниц);
e) проблемы — руководство по определению дефектов, включая системные сообщения (четыре страницы);
f) словарь терминов и определений (одна страница);
g) указатель (одна страница).
Всего 24 страницы.
С.6 Номенклатура поставки
По окончании проекта должны быть поставлены следующие объекты:
a) 500 переплетенных копий руководства;
b) электронная копия всей документации на дискетах емкостью 1,44 Мбайт, диаметром 3,5 дюйма в формате DEF 3.0 (пригодная для распечатки документации на принтере);
c) электронная копия справочного текста.
С.7 Авторские права
Авторские права на все материалы принадлежат организации XYZ.
С.8 Транспортирование
Особых условий по транспортированию продукции не требуется.
С.9 Процесс разработки и контроль
При создании руководств пользователя системы ABC должны использоваться процедуры разработки и контроля, установленные в Руководстве по качеству организации XYZ.
С.10 Тиражирование
При производстве руководств пользователя системы ABC следует использовать типографскую систему DEF (версия 3.0). Графические материалы следует разрабатывать с использованием графического пакета JKL.
Виды экранов дисплея для системы ABC следует собрать в электронном виде, а их копии — внести в окончательный документ.
Содержание и указатель должны быть подготовлены и выпущены на системе DEF.
Копии фотошаблонов должны быть отпечатаны на лазерном принтере с плотностью печати 300 точек на дюйм; за отдельную плату они могут быть распечатаны на лазерном принтере высокого качества с плотностью печати 1275 точек на дюйм.
Каждое руководство должно быть выполнено в формате А4 с двусторонней печатью и сброшюровано так, чтобы была возможность заменять листы.
Переплет должен быть формата А4 и скреплен кольцами диаметром 25 мм. На обложке должны быть приведены распечатки экранов системы ABC.
Бумага для руководств должна быть матовой и иметь плотность 103 г/см2.
Справочные тексты должны быть разработаны с использованием макетирования в системе DEF.
С.11 Проектанты
Состав коллектива разработчиков и их обязанности приведены в таблице С.2.
Таблица С.2 — Проектанты
Фамилия, имя Роль Обязанность О'Брайен П. Автор Изучение плана и написание руководств Коста А. Редактор Редактирование руководств Ричардc Р. Нормоконтролер Проверка технического содержания руководств Джонс Е. Технический аудитор Проведение технических проверок и выдача рекомендаций Вонг С. Разработчик Набор текста и подготовка графических материалов Келли А. Ответственный за качество Управление качеством Даунc М. Ответственный за тестирование Тестирование готового руководства при определенных условиях и подготовка отчета о результатах тестирования
С.12 Ресурсы
Информацию, необходимую для разработки руководств, следует выбирать из проектной документации на систему ABC, получать от разработчиков программных средств и отбирать по результатам опытной эксплуатации данной системы.
Разработчикам документации необходимы следующие ресурсы:
a) копии функциональной проектной документации на систему ABC;
b) доступ к системе ABC;
c) доступ к разработчикам программного обеспечения системы ABC.
С.13 Тестирование на практичность
После корректировки второго проекта документации по замечаниям заказчика должно быть проведено тестирование на практичность руководства пользователя и справочных текстов для системы ABC.
Целью тестирования является оценка степени, в которой язык, содержание и оформление руководства пользователя и справочных текстов для системы ABC облегчают пользователям практическое применение программных средств данной системы.
Тестирование должно проводиться в машинном зале с использованием бета-версии тестов для ABC; в тестировании должно участвовать по одному представителю от разработчиков программных средств и разработчиков документации (далее — представители).
