Информационная технология. Руководство по управлению документированием программного обеспечения (ГОСТ) - страница 7

описывающую программную продукцию для всех заинтересованных лиц.

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

учебные руководства;

справочные руководства и руководства пользователя;

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

брошюры и информационные листовки, посвященные продукции.

7.2.3 Документация управления проектом

Документы создают на основе информации управления проектом, такой как:

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

отчеты о согласованных изменениях программного обеспечения;

отчеты о решениях, связанных с разработкой;

распределение обязанностей.

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

7.3 Определение качества документов

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

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

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

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

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

7.4 Определение форматов документов

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

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

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

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

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

7.5. Определение системы обозначения документов