ГОСТ Р ИСО/МЭК 15910-2002
План документирования должен охватывать следующие вопросы (но не ограничиваться ими):
a) рабочее наименование, назначение, область применения и ограничения но использованию
плани руемой документамии;
b
) спецификацию стиля в соответствии 8.2;
c) определение аудитории пользователей (см. 8.1.3.2):
d) обоснование причин использования документации данной аудиторией и ее целевое назначение;
e) содержание (план-проспект) документации, с оценкой ее постраничного объема, и соответ
ствующие уточнения для других машинных носителей документации;
0 номенклатуру поставки — число печатных копий, наличие электронных копий, форматы
дисков и файлов (включая версии программных средств) и откуда они могут быть поставлены;
g)установление собственника авторских прав на документацию и любых других прав собствен
ности.
П р и м е ч а н и е —Вопрос прав собственности является сложным. Во всех договорах на документацию
должны быть указаны собственники соответствующих прав. При этом может быть указана последующая воз
можность передачи авторских нрав от документатора к заказчику. Передача авторских прав целесообразна при
определении места и способа тиражирования документации;
l
1т) обеспечение перевода документации на другие языки.
П р и м е ч а н и с - Подробнее см. в приложении Е;
i) уровни (грифы) секретности и конфиденциальности (при необходимости);
j) процедуры и проверки, могущие влиять на процесс разработки документации, включая, при
необходимости, хранение, поиск, резервирование, передачу и оценку качества;
k) методы и средства производства (тиражирования) и используемые версии данных средств:
) структуру коллектива разработчиков документации и, возможно, плана выбора данной струк
туры.
П р и м е ч а н и е —Конкретные лица привлекаются на различных Этапах написания и производства
(тиражирования) документации в зависимости от уровня своего опыта и знаний. Например, может быть необ
ходимым хорошее знание автором документируемой системы и опыт в написании документации; для редакто ра
может потребоваться только опыт редактирования, но нс знание системы; от компоновщика (оформите ля)
может не требоваться других знаний кроме знания средств оформления:
ш) взаимосвязи (подчиненности) проекта;
п) почасовую загрузку н зарплату персонала (руководство по оценке этих факторов приведено в
приложении F);
0) требования к проектным ресурсам, включая информационные и прочие ресурсы, представ
ляемые заказчиком, и срокам их представления;
р) метод передачи документатору информации об изменениях программного средства в процессе
его разработки;
q) планы контроля изменений и сопровождения документации (факультативно);
г) планы проверки документации после ее создания:
s) календарное планирование (графики) по контрольным точкам (milestones), включая (при
необходимости):
1) утверждение плана документирования,
2) подготовку, проверку и корректировку проекта каждого документа,
3) тестирование на практичность,
4) подготовку оригиналов фотошаблонов,
5) распечатку, переплетение и распространение документации.
При необходимости каждый из пунктов плана должен быть описан для каждого элемента доку
ментации.
П р и м е ч а н и я
1Полезно также включить в пландокументирования образцы аналогичной документации, выпускаемой
документатором или другими сторонами, чтобы показать ее стили и компоновку.
2 План документировании дачжен быть подготовлен и утвержден до начала разработки документации,
чтобы гарантировать согласование всеми сторонами поставленных задач и используемых методов. После
утверждения плана он должен быть доведен до всех заинтересованных сторон, включая персонал разработ
чиков документации, а также заказчика и субподрядчиков (например, печатников, наборщиков, переводчи
ков).
7