ГОССТАНДАРТ РОССИИ: ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ. РУКОВОДСТВО ПО УПРАВЛЕНИЮ ДОКУМЕНТИРОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

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

1) качество содержанияможно измерять в элементах точности, полноты и ясности;

2) качество структурыможно измерять легкостью, с которой читатель имеет возможность определить местоположение информации;

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

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

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

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

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

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

Стандартные обозначения документов необходимы для эффективного контроля документации. Обозначающая информация может включать в себя:

заглавие документа;

ссылочный номер документа;

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

дату выпуска и пересмотра;

реквизиты автора;

реквизиты утвердившего лица;

обозначение защищенности (авторских прав);

обозначение организации.

Если документы выпускают в виде разрозненных листов, каждая страница должна иметь индивидуальное обозначение (например, со ссылочным номером документа, номером страницы и номером издания).

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

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

конфигурационное управление; проверка; утверждение; производство; хранение; дублирование;

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

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

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

персонал (см. 9.1);

средства (см. 9.2);

финансирование (см. 9.3).

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

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

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

документирования- для разработки документации продукции,

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

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

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

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

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

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