10 ПЛАНИРОВАНИЕ ДОКУМЕНТИРОВАНИЯ
План документирования определяет, что должно быть сделано, как это должно быть сделано, когда это должно быть сделано и кто это должен делать.
План документирования может быть частью общего плана проектирования или отдельным документом. Для небольших, неофициальных проектов план может быть всего на одной странице. Для больших проектов это может быть объемный документ, который следует установленным стандартам и является предметом для официальной проверки и процедуры утверждения.
План документирования должен быть доведен до всех участников разрабатывающего коллектива и до всех, кого он касается. Должны быть четко установлены обязанности всех вовлеченных в работу, связанную с документированием.
План должен включать в себя изложение:
общей структуры документации;
типов и содержания документов;
качества и форматов документов;
обозначения документов;
комплектности и хранения документов;
обращения документов;
графика документирования.
График документирования должен распределять время для:
планирования документов;
проверки плана документирования и принципов документирования;
подготовки проектов и проверки их на техническую точность, полноту и соответствие;
редактирования при внесении комментариев, появившихся при проверке;
проведения согласования;
перевода (например, с японского на французский);
распространения.
Планирование следует начинать заранее, и план необходимо проверять на всем протяжении проекта. Подобно любому плану, план документирования отражает намечаемые действия и является объектом для необходимых изменений. В проекте должны быть предусмотрены регулярные проверки результативности изменений. в плане.
ПРИЛОЖЕНИЕ А (информационное)
КОНТРОЛЬНЫЕ ТАБЛИЦЫ ДЛЯ УПРАВЛЕНИЯ ПРОГРАММНОЙ ДОКУМЕНТАЦИЕЙ *
А1 Контрольная таблица стратегии
а) Будут ли решения направлены на:
1) создание соответствующей программной документации?
2) применение стандартов и руководств по документированию?
3) установление процедур документирования?
4) создание ресурсов, пригодных для документирования?
5) использование средств автоматизированного документирования?
6) определение штата с ответственностями за:
обеспечение стандартами и процедурами по документированию?
контроль качества документации?
б) Будет ли опубликован стратегический отчет?
А.2 Контрольная таблица стандартов
Будут ли приняты или определены стандарты для:
а) модели жизненного цикла программного обеспечения?
б) типов и содержания документов?
в) уровней качества документов?
г) форматов документов?
д) обозначения документов?
А.З Контрольная таблица процедур
Будут ли установлены для документирования процедуры:
а) планирования?
б) контроля?
в) производства?
г) проверок и утверждений?
д) распространения?
е) хранения оригинала и дубликата?
ж) актуализации?
и) продажи (распространения)?
А.4 Контрольная таблица планирования проекта
а) Будет ли создан план документирования, который включает в себя:
1) типы, содержание, качество, форматы, условия для перевода документов?
2) графики документов?
3) ассигнования на документы?
б) Будут ли определены ответственности за:
1) подготовку документов?
2) проверку и утверждение документов?
в) Будет ли штат обеспечен соответствующими средствами для задач документирования?
