Составление программной документации

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

1. Спецификация (ГОСТ 19.202-78)

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

2. Ведомость держателей подлинников (19.403-79)

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

3. Текст программы (ГОСТ 19.402-78 код вида документа - 12)

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

4. Описание программы (ГОСТ 19.402-78 код вида документа 13 )

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

5. Ведомость эксплуатационных документов (ГОСТ 19.507-79 код вида документа -20)

Должна содержать перечень эксплуатационных документов на программу.

1. Формуляр содержит основные характеристики программного обеспечении и сведения об эксплуатации программы.

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

3. Руководство программиста должно содержать сведения для эксплуатации программного обеспечения.

4. Руководство оператора, должно содержать сведения для обеспечения процедуры общения оператора с вычислительной системы.

5. Описания языка, должно содержать описание синтаксиса и семантики языка.

6. Руководство по техническому обслуживанию.

7. Программа и методика испытаний. Содержит требования подлежащие проверке при испытании программного обеспечения.

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

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

Она должна содержать всю информацию необходимую для сопровождения и модификации программного обеспечения. По стандарту ГОСТ 19.404-79 пояснительная записка должна содержать:

1. Введение (наименование программы и документа, на основании которого ведется разработка)

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

3. Технические характеристики

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

2. Описание алгоритмов и функционирование программы с обоснованием принятых решений

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

4. Описание и обоснование выбора состава технических и программных средств на основании проведенных расчетов или анализов.

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

5. Источники, используемые при разработке