Документирование программного обеспечения.

Осуществляется в соответствии с требованиями ЕСПД.

Виды программных документов:

1. Спецификация (состав программы и документация на неё);

2. Ведомость держателей подлинников (перечень предприятий, на которых хранятся подлинники программных документов);

3. Техническое задание (требование к программе, стадии и сроки разработки, виды испытаний);

4. Пояснительная записка (общее описание алгоритма и функционирования программы);

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

6. Описание программы (сведения логической структуре и функционировании программы);

7. Текст программы (с использованием комментариев);

8. Эксплуатационные документы:

   1. Ведомость эксплуатационных документов;

   2. Формуляр – это основные характеристики программы, комплектность и сведения о программе эксплуатации;

   3. Описание применения (назначение, область применения, методы и классы решаемых задач);

   4. Руководство программиста (сведения, необходимые для эксплуатации программы);

   5. Руководство системного программиста (сведения для проверки обеспечения функционирования и настройки программы на условие конкретного применения);

   6. Описание языка (синтаксис и семантика языка взаимодействия пользователя и программы);

   7. Руководство оператором (сведения, необходимые для обеспечения процедуры общения оператора с ЭВМ в процессе выполнения программ);

   8. Руководство по техническому обслуживанию (описание применения тестовых и диагностических программ при обслуживание технических средств);

Состав программного документа:

1. Лист утверждения (заказчик и исполнитель, их подписи).

2. Титульный лист.

3. Анатация.

4. Содержание.

5. Текст документа

6. Приложение.

7. Перечень сопроводительных документов.

Содержание основных документов.

Техническое задание:

1. Введение.

2. Основание для разработки.

3. Назначение разработки.

4. Требования к программному изделию:

1. функциональным характеристикам;

2. условиям эксплуатации;

2. составу и параметрам технических средств;

3. маркировке, транспортированию, упаковке и хранению.

5. Требование к программной документации.

6. Технико-экономические показатели.

7. Стадии и этапы разработки.

8. Порядок контроля и приёмки.

Пояснительная записка:

1. Введение.

2. Назначения и область применения.

3. Технологические характеристики:

   1. Постановка задачи, описание математических методов, допущения и ограничения;

   2. Описание алгоритма программ с обоснованием выбора схемы алгоритма;

   3. Описание и обоснование выбора метода организации входных и выходных данных, состав технических и программных средств;

4. Описание технико-экономических показателей.

Программа и методика испытаний:

1. Объект испытаний.

2. Цель испытаний.

3. Состав предъявляемой документации.

4. Технические требования:

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

2. к техническим характеристикам;

3. к информационной и программной совместимости.

5. Порядок проведения испытаний.

6. Методы испытаний.

Описание программы:

1. Общие сведения.

2. Функциональные назначения.

3. Входные данные.

4. Описание логической структуры:

   1. Используемые методы;

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

   3. Структура и организация данных.

   4. Алгоритмы программы.

   5. Связь с другими программами.

5. Вызов и загрузка.

6. Используемые технические средства.

Описание применения:

1. Назначение программы.

2. Условия применения.

3. Описания задачи.

4. Входные и выходные данные.

Описание языка:

1. Общие сведения.

2. Синтаксис и семантика элементов.

3. Операторы.

4. Средства обмена данными.

5. Средства отладки программы.

Руководство оператора:

1. Назначение программы.

2. условие выполнения программы.

3. Выполнение программы.

4. Сообщения оператору.

Руководство программиста:

1. Назначение и условия применения программы.

2. Характеристики программы.

3. Обращение к программе.

4. Входные и выходные данные.

5. Сообщения.