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

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

Выбор модели жизненного цикла программного обеспечения

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

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

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

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

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

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

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

7.2.1. Документация разработки

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

Разработка документов преследует пять целей:

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

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

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

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

5) они описывают историюразработки программного обеспечения.

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

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

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

· спецификации функций;

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

· планы разработки;

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

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

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

7.2.2. Документация продукции

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

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

2) она облегчает программистам, не разрабатывавшим программное обеспечение, его сопровождение и модернизацию;

3) она помогает продаже или приемкепрограммной продукции.

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

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

· операторов,которые «прогоняют» программное обеспечение на вычислительной системе;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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