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

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

l) структуру коллектива разработчиков документации и, возможно, плана выбора данной структуры.

Примечание — Конкретные лица привлекаются на различных этапах написания и производства (тиражирования) документации в зависимости от уровня своего опыта и знаний. Например, может быть необходимым хорошее знание автором документируемой системы и опыт в написании документации; для редактора может потребоваться только опыт редактирования, но не знание системы; от компоновщика (оформителя) может не требоваться других знаний кроме знания средств оформления;

m) взаимосвязи (подчиненности) проекта;

n) почасовую загрузку и зарплату персонала (руководство по оценке этих факторов приведено в приложении F);

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

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

q) планы контроля изменений и сопровождения документации (факультативно);

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

s) календарное планирование (графики) по контрольным точкам (milestones), включая (при необходимости):

1) утверждение плана документирования,

2) подготовку, проверку и корректировку проекта каждого документа,

3) тестирование на практичность,

4) подготовку оригиналов фотошаблонов,

5) распечатку, переплетение и распространение документации.

При необходимости каждый из пунктов плана должен быть описан для каждого элемента документации.

Примечания

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

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

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

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

Примечания

1 Данные об определении аудитории пользователей могут быть получены из:

a) результатов изучения аудитории, проведенного заказчиком или документатором;

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

c) определений аудитории, полученных из других источников.

2 По возможности персонал разработчиков документации должен организовать встречи с типовыми пользователями в их рабочей обстановке и обследовать их работу.

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

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

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

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

Примечание — Целью проверки является гарантирование полноты и правильности представленных материалов и удовлетворения ими потребностей заказчика в соответствии с условиями договора и планом документирования.

Проверка должна проводиться персоналом заказчика, обладающим соответствующей квалификацией и полномочиями по предложению изменений в документацию и утверждению измененной документации.