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

Программные документы можно представить разделенными на три категории:

документация разработки;

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

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

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

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

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

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

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

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

д) они описывают историю разработки ПО.

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

анализы осуществимости и исходные заявки;

спецификации требований и функций;

проектные спецификации, включая спецификации программ и данных;

планы разработки, сборки и тестирования ПО;

планы обеспечения качества, стандарты и графики;

защитная и текстовая информация.

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

Документация продукции преследует три цели:

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

облегчение сопровождения и модернизации ПО программистам, не разрабатывавших ПО;

помощь при продаже или приемке ПО.

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

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

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

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

руководства по сопровождению ПО;

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

ГОСТ Р ИСО 9127-94 “Системы обработки информации. Документация пользователя и информация на упаковке для потребительских пакетов” вводит определение документации пользователя, как документации, которая обеспечивает пользователей информацией, необходимой для установки и прогона ПО и является обязательной в поставке (документация пользователя выполняется в виде одного или нескольких руководств и вкладывается вместе с программным продуктом внутрь упаковки).

Данный стандарт определяет три категории информации:

обязательная - информация, поставляемая с каждым пакетом;

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

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

Назначением документации пользователя является обеспечение конечного пользователя достаточной информацией для ясного понимания:

цели, функций и характеристик ПО;

того, как ввести в действие и использовать ПО;

договорных прав и обязанностей.

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

Таким образом, ГОСТ Р ИСО 9127, не имея формальных ссылок на ГОСТ Р ИСО/МЭК ТО 9294, фактически дополняет введенное в нем понятие документации продукции.

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

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

отчеты о согласованных изменениях ПО;

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

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

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