Программная документация является неотъемлемым компонентом программного продукта и должна оформляться в соответствии с Единой системой программной документации(ЕСПД-ГОСТ-серии 19)
Для того чтобы написать программную документацию необходимо вооружиться ГОСТами.
В состав ЕСПД входят:
- Основополагающие и организационно-методические стандарты.
- Стандарты, определяющие формы и содержание программных документов, применяемых при обработки данных.
- Стандарты, обеспечивающие автоматизацию разработки программных документов.
Программная документация включает:
- Техническое задание (назначение, область применения программы, требования, предъявляемые к программе).
- Текст программы (запись программы с необходимыми комментариями).
- Описание программы( сведения о логической структуре и функционировании программы).
- Пояснительная записка( схема алгоритма, общее описание алгоритма и /или функционирования программы, обоснование принятых решений).
- Эксплуатационные документы.
Программный документ «Пояснительная записка» составляется на стадии эскизного или технического проектов программы. На стадии рабочего проекта не используется.
К эксплуатационным документам относятся:
- Описание применения ( сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств)
- Руководство системного программиста (сведения для проверки, функционирования и настройки программы на условия конкретного применения).
- Руководство программиста (сведения для эксплуатации программы)
- Руководство оператора (сведения для обеспечения общения оператора с вычислительной системой в процессе выполнения программы)
- Описание языка (описание синтаксиса и семантики языка)
- Руководство по техническому обслуживанию ( сведения для применения текстовых и диагностических программ при обслуживании технических средств)
Основная часть программной документации составляется на стадии рабочего проекта. Необходимость того или иного документа определяется на этапе составления технического задания. Допускается объединить отдельные виды документов.
Чтобы избежать неверного написания программной документации, нужно руководствоваться нормативными документам ЕСПД.
Как оформить программную документацию.
Объект: Анализ оформления программной документации.
Предмет: Программная документация.
Цель: Рассмотреть правила оформления программной документации
- Рассмотреть категории и состав программной документации.
- Рассмотреть стадии и этап программной документации.
- Рассмотреть правила оформления программной документации.
- Привезти перечень нормативных документов, необходимых для написания программной документации.
