Информационная технология. Процесс создания документации пользователя программного средства - [14]
Каждое руководство должно быть выполнено в формате А4 с двусторонней печатью и сброшюровано так, чтобы была возможность заменять листы.
Переплет должен быть формата А4 и скреплен кольцами диаметром 25 мм. На обложке должны быть приведены распечатки экранов системы ABC.
Бумага для руководств должна быть матовой и иметь плотность 103 г/см>2.
Справочные тексты должны быть разработаны с использованием макетирования в системе DEF.
С.11 Проектанты
Состав коллектива разработчиков и их обязанности приведены в таблице С.2.
Таблица С.2 — Проектанты
| Фамилия, имя | Роль | Обязанность |
|---|---|---|
| О'Брайен П. | Автор | Изучение плана и написание руководств |
| Коста А. | Редактор | Редактирование руководств |
| Ричардc Р. | Нормоконтролер | Проверка технического содержания руководств |
| Джонс Е. | Технический аудитор | Проведение технических проверок и выдача рекомендаций |
| Вонг С. | Разработчик | Набор текста и подготовка графических материалов |
| Келли А. | Ответственный за качество | Управление качеством |
| Даунc М. | Ответственный за тестирование | Тестирование готового руководства при определенных условиях и подготовка отчета о результатах тестирования |
С.12 Ресурсы
Информацию, необходимую для разработки руководств, следует выбирать из проектной документации на систему ABC, получать от разработчиков программных средств и отбирать по результатам опытной эксплуатации данной системы.
Разработчикам документации необходимы следующие ресурсы:
a) копии функциональной проектной документации на систему ABC;
b) доступ к системе ABC;
c) доступ к разработчикам программного обеспечения системы ABC.
С.13 Тестирование на практичность
После корректировки второго проекта документации по замечаниям заказчика должно быть проведено тестирование на практичность руководства пользователя и справочных текстов для системы ABC.
Целью тестирования является оценка степени, в которой язык, содержание и оформление руководства пользователя и справочных текстов для системы ABC облегчают пользователям практическое применение программных средств данной системы.
Тестирование должно проводиться в машинном зале с использованием бета-версии тестов для ABC; в тестировании должно участвовать по одному представителю от разработчиков программных средств и разработчиков документации (далее — представители).
Тестирование должно проводиться с привлечением четырех типовых пользователей, перечисленных в С.4, выбранных произвольно из персонала ночной смены, эксплуатирующего систему. Каждому из них должны быть даны копии руководства пользователя и справочных текстов для системы ABC с просьбой выполнить ряд действий (перечисленных в плане тестирования).
Представители записывают время выполнения каждого действия, замечания пользователя и процессы, выполняемые пользователями при реализации каждого действия.
При превышении любым пользователем времени выполнения действия, указанного в плане тестирования, или неправильном выполнении данного действия представители записывают соответствующие замечания пользователя о причинах возникшей проблемы.
Эти замечания представляются на совещании по рассмотрению документации и в качестве изменений в проект документации. На совещании определяют целесообразность проведения повторного тестирования.
С.14 График работ
График работ показан в таблице С.З.
Таблица С.З — График работ
| Этап | Срок | Отношения |
|---|---|---|
| Представление первого проекта | 01.01.99 | План документирования утвержден 15.12.98 |
| Представление второго проекта | 15.02.99 | Три недели на проверку первого проекта |
| Тестирование на практичность | 15.03.99 | |
| Представления справочных текстов | 15.04.99 | Тестирование на практичность |
| Представление гранок | 15.04.99 | Тестирование на практичность; две недели на проверку второго проекта |
| Подготовка фотошаблонов | 30.04.99 | Тестирование на практичность |
| Распечатка и брошюровка | 15.05.99 | Наличие переплетенных томов |
ПРИЛОЖЕНИЕ D (справочное)
Отношения между аудиториями, выданными заданиями, бумажной и диалоговой документацией
Проектирование документации начинается с анализа пользователей документируемой системы. Как правило, существуют определенные группы пользователей, объединяемые в определенные аудитории в соответствии с их потребностями.
Рисунок D.1 — Иерархия аудиторий
В ряде случаев иерархию аудиторий целесообразно представлять в виде отдельных групп, как показано на рисунке D.1.
В ряде случаев следует выбирать аудиторию, исходя из опытности пользователя данной аудитории по использованию системы. Например, аудитории могут быть определены как «Неопытные пользователи» или «Опытные пользователи».
После определения перечня аудиторий для конкретной системы на следующем этапе следует определить задания (tasks), выполняемые каждой аудиторией. Часто данные задания представляют в виде иерархической структуры (см. рисунок D.2).
Рисунок D.2 — Иерархия заданий
На следующем этапе для определенной аудитории в рамках выданных ей заданий определяют перечень ее потребностей в информации (information needs). На основе данного перечня определяют содержание конкретного документа, как показано на рисунке 3.
Рисунок D.3 — Информационные потребности
На данном этапе (но не ранее) следует определить вид (тип) конкретного документа и машинный носитель, на котором он поставляется.
