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

g) не должны использоваться упоминания первых лиц государства;

h) не следует выражать даты только в числовом виде. Месяц всегда должен быть написан полностью (например, 28 июля 1991);

i) обычно следует использовать двумерные представления, если международные соглашения не требуют иного (например, для автошин, водопроводов, гвоздей и фотопленки);

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

ПРИЛОЖЕНИЕ F (справочное) Оценка проекта

F.1 Общие положения

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

Данные методы позволяют сделать практические прикидки, на фактические сроки реализации проекта следует проставлять исходя из практического опыта экспертов, проводящих соответствующие оценки.

F.2 Поминутный и почасовой методы

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

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

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

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

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

Таблица F.1 — Ориентировочные сроки

Этап	Срок
Определение номенклатуры поставки	16 ч на проект
Исследование содержания документации	24 ч на проект
Написание плана документирования	48 ч на проект
Проектирование структуры документа и правил оформления его страниц	8 ч на том
Написание первой редакции (документации)	1 ч на страницу
Разработка графических материалов	5 ч на материал
Объединение текстовых и графических материалов	30 мин на страницу
Проверка первой редакции (эксперт)	30 мин на страницу
Корректировка первой редакции и графики	30 мин на страницу
Внесение замечаний пользователя	30 мин на страницу
Грамматическое редактирование	15 мин на страницу
Подготовка второй редакции (документации)	15 мин на страницу
Проверка второй редакции (эксперт)	15 мин на страницу
Окончательная корректировка документации	10 мин на страницу
Нормоконтроль документации	15 мин на страницу
Изготовление фотошаблонов	3 сут
Печать и переплетение оригиналов	5 сут
Печать и брошюровка копий	10 сут
Рассылка	1 сут

F.3 Метод нисходящего проектирования

F.3.1 Общие положения

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

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

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

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