10 ПЛАНИРОВАНИЕ ДОКУМЕНТИРОВАНИЯ

10 ПЛАНИРОВАНИЕ ДОКУМЕНТИРОВАНИЯ

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

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

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

План должен включать в себя изложение:

общей структуры документации;

типов и содержания документов;

качества и форматов документов;

обозначения документов;

комплектности и хранения документов;

обращения документов;

графика документирования.

График документирования должен распределять время для:

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

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

подготовки проектов и проверки их на техническую точность, полноту и соответствие;

редактирования при внесении комментариев, появившихся при проверке;

проведения согласования;

перевода (например, с японского на французский);

распространения.

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