Файл: Учебное пособие.doc

6.1.4.Функции программной документации

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

Программную документацию можно рассматривать как имеющую шесть основных функций:

• информация для управления;

• связь между задачами;

• обеспечение качества;

• инструкции и справки;

• сопровождение программного обеспечения;

• исторические справки.

6.1.4.1.Информация для управления

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

6.1.4.2.Связь между задачами

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

В типовом варианте:

• специалисты в предметной области начинают проект;

• аналитики формулируют требования к системе;

• проектировщики разрабатывают системный и программный проекты;

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

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

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

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

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

6.1.4.3.Обеспечение качества

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

6.1.4.4.Инструкции и справки

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

6.1.4.5.Сопровождение программного обеспечения

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

6.1.4.6.Исторические справки

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

6.1.5.Установление стратегии документирования

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

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

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

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

Документация требуется на ранних стадиях проекта и должна быть доступна и сопровождаться на всём протяжении процесса разработки программного обеспечения. После завершения процесса разработки документация необходима для использования, сопровождения, модернизации, преобразования или передачи программного обеспечения;

2) документирование должно быть управляемым.

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

3) документация должна соответствовать ее читательской аудитории.

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

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

Процесс разработки должен быть определен;

5) должны быть определены и использованы стандарты по документированию.

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

6) должны быть определены средства поддержки.

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

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

Внутри организаций должны быть приняты стандарты и руководства для:

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

• типов и взаимосвязей документов;

• содержания документа;

• качества документа;

• форматов документа;

• обозначения документа.

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

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

Большинство стандартов и руководств -выдают рекомендации,, которые применимы на общем уровне. Зачастую будут требоваться управленческие решения для адаптации общих рекомендаций к конкретным проектам. Применение стандартов, распространяющихся на организацию документирования, облегчит руководителям проекта определение следующих вопросов:

• какие типы документов требуются?

• каков объем представляемой документации?

• что документы содержат?

• какой уровень качества будет достигнут?

• где документы будут созданы?

• как документы будут хранить, сопровождать и обращать?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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