Тиражирование и распространение документации (седьмая работа на рис. 42) производится документатором в соответствии с планом документиро- вания.
В плане документирования должны быть определены контроль измене- ний и сопровождение документации. При этом должны быть предусмотрены четыре типа изменений документации:
функциональные изменения данной версии – изменения функции ПС, внесенные при разработке документации и отраженные в опубликованной до- кументации;
функциональные изменения последующей версии – изменения функции ПС, внесенные при разработке документации и не отраженные в опубликован-
ной документации, но подлежащие учету в последующей редакции документов;
изменения ПС после публикации – изменения функций ПС после издания данной документации;
изменения документа после публикации – изменения в опубликованной документации, обусловленные изменениями ПС или обнаружением погрешно- стей в данной документации.
Необходимо выполнять проектирование документации так, чтобы допус- тить внесение в нее изменений всех четырех видов. Для этого необходимо пре- дусмотреть процедуру внесения в документ каждого типа изменений.
Приложение В стандарта ИСО/МЭК 15910 содержит краткие рекоменда- ции по адаптации и практическому использованию положений данного стан- дарта в конкретном договоре.
Содержание плана документирования
План документирования должен охватывать следующие вопросы (но не ограничиваться ими):
рабочее наименование, назначение, область применения и ограничения по использованию планируемой документации;
спецификация стиля;
определение аудитории пользователей;
целевое назначение планируемой документации;
содержание (план-проспект) документации с оценкой ее постраничного объема и соответствующие уточнения для других машинных носителей доку- ментации;
номенклатура поставки – число печатных копий, наличие электронных копий, форматы дисков и файлов (включая версии программных средств);
установление собственника авторских прав на документацию и любых других прав собственности;
обеспечение перевода документации на другие языки (при необходимо- сти);
уровни (грифы) секретности и конфиденциальности документации (при необходимости);
процедуры и проверки, могущие влиять на процесс разработки доку- ментации, включая (при необходимости) хранение, поиск, резервирование, пе- редачу и оценку качества документации;
методы и средства производства (тиражирования) документации;
структура коллектива разработчиков документации и, возможно, план выбора данной структуры;
взаимосвязи проекта документации;
почасовая загрузка и зарплата разработчиков документации;
требования к проектным ресурсам (включая информационные и прочие
ресурсы, предоставляемые заказчиком) и срокам их представления;
метод передачи документатору информации об изменениях программ- ного средства в процессе его разработки;
планы контроля изменений и сопровождения документации (при необ- ходимости);
планы проверки документации после ее создания;
календарное планирование (графики) документирования по контроль- ным точкам, включая (при необходимости):
утверждение плана документирования;
подготовку, проверку и корректировку проекта каждого доку- мента;
тестирование на практичность;
подготовку оригинала фотошаблонов;
распечатку, переплетение и распространение документации.
При необходимости каждый из пунктов плана должен быть описан для ка- ждого элемента документации.
В Приложении С стандарта ИСО/МЭК 15910 представлен образец плана документирования, содержащий следующие разделы: область применения и ог- раничения, оформление и стиль описания, аудитория, проект содержания доку- ментации, номенклатура поставки, авторские права, транспортирование, про- цесс разработки и контроль, тиражирование, коллектив разработчиков доку- ментации, ресурсы, тестирование на практичность, график работ.
Требования к содержанию спецификации стиля документации
В стандарте ИСО/МЭК 15910 отражено содержание спецификации стиля документации.
Спецификация стиля должна содержать правила оформления документа- ции различных типов. Например, для бумажных документов это может быть компоновка документа, заголовки, шрифты, перечень вводных и вспомогатель- ных материалов, схемы нумерации страниц, таблиц, рисунков и т.п. Для элек- тронных документов это может быть подсветка, использование цвета, шрифты, заголовки, навигация и т.п. Стандарт ИСО/МЭК 15910 не определяет состава конкретных требований к оформлению документов, а определяет лишь содер- жание и диапазоны требований.
Do'stlaringiz bilan baham: |