6.6 Документирование ппп

Создание и использование ППП – от формирования концепции и требований к первой версии до изъятия его из эксплуатации сопровождается документированием объектов и процессов жизненного цикла ППП [9].

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

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

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

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

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

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

• документацию испытаний ППП;

• документацию сопровождения и управления конфигурацией ППП.

В состав проектной документации входят:

1. отчет по обследованию предметной области, для которой предназначен разрабатываемый ППП, с описанием комплекса задач, выбранных для реализации;

2. описание концепции проектирования ППП;

3. техническое задание на проектирование ППП;

4. план-график работ, связанных с созданием ППП;

5. спецификации эскизного и технического проекта ППП;

6. документация на разработанные программные модули ППП;

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

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

1. исходные данные для проведения тестирования (методы тестирования, тестовые наборы, эталонные значения, реальные ресурсы тестирования (временные, аппаратно-программные, людские), критерии полноты и качества тестирования);

2. программа (сценарии) тестирования;

3. журнал тестирования;

4. итоговый отчет о результатах тестирования.

В состав документации испытаний входят:

1. программа испытаний;

2. описание методов и методик испытаний;

3. протоколы испытаний;

4. акт завершения работ;

5. акт приемки ППП в эксплуатацию.

В состав документации сопровождения управления конфигурацией входят:

1. отчеты пользователей о выявленных дефектах и предложения по корректировке программ;

2. журнал выявленных дефектов и предложений по совершенствованию и развитию версии ППП;

3. журнал подготовленных и утвержденных корректировок, а также реализованных изменений в новой версии ППП;

4. отчет о результатах эксплуатации снятой с сопровождения версии ППП;

5. журнал тиражирования и характеристик базовых версий, поддерживаемых сопровождением.

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

Пользовательская документация включает в себя:

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

2. общее описание информационной системы (ИС), в составе которой будет использоваться ППП (назначение и описание ИС, описание взаимосвязей ППП с другими составляющими ИС);

3. руководство администратора программного средства, которое регламентирует функции администрирования при применении ППП, процедуры по инсталляции и подготовке ППП к эксплуатации, порядок и средства ведения базы данных и восстановления информации при сбоях;

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

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

На машинном уровне программного продукта, как правило, создаются:

• автоматизированная контекстно-зависимая помощь (HELP);

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