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

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

a) автор может за месяц подготовить 22 страницы нового текста;

b) автор может за месяц подготовить 44 страницы текста с изменениями.

Например, объем публикации оценен в 150 страниц. Поскольку это новая публикация, получаем: 150/22 = 7 чел./мес. В эти 7 мес входят: планирование публикации, ее написание, редактирование и проверка двух редакций, а также подготовка фотошаблонов.

Продолжительность 7 чел./мес распределена в следующих пропорциональных отношениях:

a) 15 % — планирование (в данном примере — четыре недели);

b) 50 % — написание первой редакции (14 недель);

c) 25 % — написание второй редакции (семь недель);

d) 10 % — подготовка фотошаблонов (три недели).

Период планирования охватывает:

a) исследования и подготовку плана;

b) изучение и проверку плана;

c) корректировку плана по результатам проверки.

Период первой редакции охватывает:

a) подготовку содержания (плана-проспекта) документации;

b) изучение и проверку содержания (плана-проспекта);

c) подготовку пробного куска текста для редактора;

d) редактирование пробного куска текста и его переписывание по замечаниям редактора;

e) написание всей первой редакции документации;

f) редактирование всей первой редакции документации;

g) переработку отредактированной документации;

h) изучение и проверку переработанной документации.

Иллюстративные материалы готовят одновременно с текстом первой редакции.

Период второй редакции охватывает:

a) внесение в документацию всех изменений, предложенных по результатам проверки первой редакции;

b) повторное (второе) редактирование второй редакции документации;

c) переработку отредактированной документации;

d) изучение и проверку переработанной документации.

Редакцией для фотонабора является принятая редакция документирования. Ее подготовка охватывает:

a) внесение в документацию всех изменений, предложенных по результатам проверки второй редакции;

b) проверку правильности внесения данных изменений;

c) удаление всех редакционных разметок;

d) изготовление фотошаблонов;

e) отправку фотошаблонов в печать (в типографию).

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

Метод нисходящего проектирования может быть использован для существующих публикаций. Например, книга объемом 100 страниц может быть переработана так, что половина ее изменяется и добавляется 10 % новых материалов. Используя вышепринятые допущения, получаем: 50/44 = 1,13 чел./мес для существующего материала плюс 10/22 = 0,45 чел./мес для внесения нового материала.

Когда сроки, необходимые для создания документации, превышают допустимые, для выполнения задания следует привлекать несколько авторов. Так же следует поступать при подготовке нескольких документов для одного программного средства.

Использование настоящего стандарта во взаимоотношениях между заказчиком и документатором способствует созданию качественной документации в частности потому, что между ними согласовывается план документирования. Этим достигается двойной эффект: во-первых, документатор учитывает все аспекты документации, оговоренные в плане; во-вторых, заказчик и документатор согласуют метод документирования, определенный в плане, еще до начала работы.

Заказчик должен установить наличие в плане документирования следующих элементов:

a) соответствующих определений всех аудиторий. Формулировка вида «Руководство предназначено для аудитории, охватывающей пользователей программного средства» неполна (см. приложение D). В определение аудитории должны быть включены все лица, могущие использовать данное программное средство (включая лиц, которые могут только просматривать отчеты или сообщения от данного средства);

b) содержания (планов-проспектов) документации с оценкой их постраничного объема;

c) определения числа печатных копий и методов печати (тиражирования) и брошюровки документации;