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

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

Процедуры определяют последовательность документирования:

– планирование;

– подготовка;

– конфигурационное управление;

– проверка;

– утверждение;

_– производство;

– хранение; дублирование;

– распространение и модернизация; продажа.

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

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

Основными ресурсами, требуемыми для документирования, являются следующие:

– персонал;

– средства;

– финансирование.

Персонал

Для процесса разработки программного обеспечения необходимы люди со знанием:

– программирования — для разработки программного обеспечения;

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

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

– проектировщики программного обеспечения и программисты создают документацию разработки, которая описывает продукцию или ее задачи; они также обеспечивают документацию сопровождения программной продукции;

– специалисты в предметной области обеспечивают информацию для (и могут разрабатывать) части стадий 'изучения, спецификаций требований, планов тестирования и обеспечения качества, планов сборки программного обеспечения в условиях эксплуатации и многих типов графиков;

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

Средства

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

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

Финансирование

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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