ПРИЛОЖЕНИЕ G (справочное)

Оценка плана документирования

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

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

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

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

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

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

e) установление методов подготовки документации. Большинство технических документов может быть создано при помощи компьютера;

f) достаточных сроков для проверки заказчиком редакций документации. Любые отсрочки при возврате документатору проверенных редакций могут привести к срыву сроков поставки документации;

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

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







 


Главная | В избранное | Наш E-MAIL | Добавить материал | Нашёл ошибку | Наверх