В настоящем плане описана стратегия разработки документации пользователя для системы ABC, представляемой в виде комплекта документации XYZ. Определена область применения проекта, номенклатура поставки документации и ресурсы, необходимые для ее создания.
Данная стратегия предусматривает создание твердых копий документации и диалоговой документации в виде справочных текстов.
В случае изменения данной стратегии следует пересмотреть план документирования.
В комплекте документации не предусмотрены инструкции по применению операционной системы, на которой прогоняется система ABC. Однако для читателя должны быть указаны ссылки на соответствующие руководства по данному вопросу.
Инсталляция, ввод в действие и управление документацией системы ABC уже реализованы и не рассматриваются в настоящем проекте.
По умолчанию следует использовать оформление и стиль описания, указанные в ГОСТ Р ИСО/МЭК 15910. Образец страницы приложен к плану документирования.
Таблица С.1 — Руководство по стилю
| Элемент | Значение |
|---|---|
| Содержание справочного текста | Должен быть описан только контекст справки |
| Содержание диалоговой документации | Отсутствует |
| Сопутствующие материалы | Справочный текст для каждого объекта должен быть представлен на одном экране |
| Засветки и использование цветов | В справочном тексте не следует использовать цвета и другие засветки |
| Оформление диалоговой документации и справочного текста | Должен быть использован одноколонный формат |
| Оформление заголовков диалоговой документации и справочного текста | Вверху каждой страницы справочного текста должен быть проставлен заголовок первого уровня: кегль 14 п, гарнитура Times Roman |
| Оформление основной части документа | Текст должен быть выровнен по левому краю и набран одним шрифтом |
| Правила навигации | В соответствии со справочным механизмом системы ABC |
| Использование клавиатуры | В соответствии со стандартами на систему ABC |
В аудиторию пользователей данной системы входят операторы компьютеров, обладающие минимальными техническими знаниями. Минимальное образование операторов должно соответствовать 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.
Виды экранов дисплея для системы ABC следует собрать в электронном виде, а их копии — внести в окончательный документ.
Содержание и указатель должны быть подготовлены и выпущены на системе DEF.
Копии фотошаблонов должны быть отпечатаны на лазерном принтере с плотностью печати 300 точек на дюйм; за отдельную плату они могут быть распечатаны на лазерном принтере высокого качества с плотностью печати 1275 точек на дюйм.
Каждое руководство должно быть выполнено в формате А4 с двусторонней печатью и сброшюровано так, чтобы была возможность заменять листы.
Переплет должен быть формата А4 и скреплен кольцами диаметром 25 мм. На обложке должны быть приведены распечатки экранов системы ABC.
Бумага для руководств должна быть матовой и иметь плотность 103 г/см2.
Справочные тексты должны быть разработаны с использованием макетирования в системе DEF.
Состав коллектива разработчиков и их обязанности приведены в таблице С.2.
Таблица С.2 — Проектанты
| Фамилия, имя | Роль | Обязанность |
|---|---|---|
| О'Брайен П. | Автор | Изучение плана и написание руководств |
| Коста А. | Редактор | Редактирование руководств |
| Ричардc Р. | Нормоконтролер | Проверка технического содержания руководств |
| Джонс Е. | Технический аудитор | Проведение технических проверок и выдача рекомендаций |
| Вонг С. | Разработчик | Набор текста и подготовка графических материалов |
| Келли А. | Ответственный за качество | Управление качеством |
| Даунc М. | Ответственный за тестирование | Тестирование готового руководства при определенных условиях и подготовка отчета о результатах тестирования |
Информацию, необходимую для разработки руководств, следует выбирать из проектной документации на систему ABC, получать от разработчиков программных средств и отбирать по результатам опытной эксплуатации данной системы.
Разработчикам документации необходимы следующие ресурсы:
a) копии функциональной проектной документации на систему ABC;
b) доступ к системе ABC;
c) доступ к разработчикам программного обеспечения системы ABC.
После корректировки второго проекта документации по замечаниям заказчика должно быть проведено тестирование на практичность руководства пользователя и справочных текстов для системы ABC.
Целью тестирования является оценка степени, в которой язык, содержание и оформление руководства пользователя и справочных текстов для системы ABC облегчают пользователям практическое применение программных средств данной системы.
Тестирование должно проводиться в машинном зале с использованием бета-версии тестов для ABC; в тестировании должно участвовать по одному представителю от разработчиков программных средств и разработчиков документации (далее — представители).
Тестирование должно проводиться с привлечением четырех типовых пользователей, перечисленных в С.4, выбранных произвольно из персонала ночной смены, эксплуатирующего систему. Каждому из них должны быть даны копии руководства пользователя и справочных текстов для системы ABC с просьбой выполнить ряд действий (перечисленных в плане тестирования).
Представители записывают время выполнения каждого действия, замечания пользователя и процессы, выполняемые пользователями при реализации каждого действия.
При превышении любым пользователем времени выполнения действия, указанного в плане тестирования, или неправильном выполнении данного действия представители записывают соответствующие замечания пользователя о причинах возникшей проблемы.
Эти замечания представляются на совещании по рассмотрению документации и в качестве изменений в проект документации. На совещании определяют целесообразность проведения повторного тестирования.
График работ показан в таблице С.З.
Таблица С.З — График работ
| Этап | Срок | Отношения |
|---|---|---|
| Представление первого проекта | 01.01.99 | План документирования утвержден 15.12.98 |
| Представление второго проекта | 15.02.99 | Три недели на проверку первого проекта |
| Тестирование на практичность | 15.03.99 | |
| Представления справочных текстов | 15.04.99 | Тестирование на практичность |
| Представление гранок | 15.04.99 | Тестирование на практичность; две недели на проверку второго проекта |
| Подготовка фотошаблонов | 30.04.99 | Тестирование на практичность |
| Распечатка и брошюровка | 15.05.99 | Наличие переплетенных томов |