3.Документирование пс.

Документацию делят на 2е группы:

1) Документы управления разработкой пс:

ДУРПС (software process documentation)

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

1)) Планы, оценки и расписания (создаются для прогнозирования и управления процессами разработки и сопровождения ПС)

2)) Отчеты об использовании ресурсов в процессе разработки.

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

4)) Рабочие документы (Технические док-ты обеспечивающие связь между разработчиками)

5))Заметки и переписка это документы фиксируют различные детали взаимодействие между менеджерами и разработчиками.

2) Документы входящие в состав пс.

ДВСПС (software product documentation). Описывают программы ПС как с точками зрения их применения пользователями и с точки зрения их разработчиков и сопроводителей. Документы используются на стадии разработки и эксплуатации, эти документы образуют два комплекта с разными назначениями:

1)) Пользовательская документация пс (п-документация)

П-документация (user documentation) объясняет пользователям как они должны действовать, чтобы применить, разрабатываемое ПС. К такой док-ции относятся документы, которыми должен руководствоваться пользователь при инсталляции ПС, при применении ПС для решения своих задач и при управлении ПС.

Два вида:

1))) Ординарный пользователь ПС (end user). Используют ПС для решения своих задач в своей предметной области. Пример: инженер – разрабатывающий тех. устройство. Кассир продающая Ж/Д, авиа-билеты.

2))) Администратор ПС (System administrator) Управляет использованием ПС ординарными пользователями и осуществляет сопровождение ПС не связанное с модификацией программы. Пример: Он может регулировать права доступа к ПС, поддерживать ПС в рабочем состоянии и т.д.

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

В состав П-документации входят:

а) Общее функциональное описание ПС даёт краткую хар-ку функциональных возможностей ПС.

б) Руководство по инсталляции ПС. Предназначена для инсталляции ПС.

в) Инструкция по применению ПС. Предназначена для end user. Содержит необходимую информацию по применению ПС организованную в форме удобной для изучения.

г) Справочник по применению ПС. Предназначен для end user. Представляется в форме удобной для избирательного поиска отдельных эл-ов.

д) Руководство по управлению ПС. Предназначена для администраторов.

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

2)) С-документация (system documentation)

Описывает ПС с точки зрения её разработки. Эта док-ция необходима, если ПС предполагает изучение того, как оно устроено и модернизацию его программ.

Сопровождение – это продолжающаяся разработка.

Две группы С-документации:

1) Документация определяющая строение программ и структур данных ПС и технологию их разработки. Содержит итоговые документы каждого технологического этапа разработки ПС и включает след-цие док-ты.

1)) Внешнее описание ПС.

2)) Описание архитектуры ПС, включая спецификацию каждой эл. подсистемы.

3)) Для каждой программы ПС – описание модульной структуры включая внешнюю спецификацию каждого включенного в нее модуля.

4)) Для каждого модуля описания его строения.

5)) Тесты модулей на выбранном языке программирования.

6)) Док-ты установления достоверности ПС (как входных данных, так и каждой подпрограммой ПС).

2) Док-ция помогающая вносить изменения в ПС.