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

Программные документы и их содержание:

- спецификация – перечень и назначение всех файлов ПС, включая файлы документации;

- ведомость держателей подлинников – список предприятий, хранящих подлинники программных документов, составляет­ся только для сложных ПС;

- текст программы – запись кодов программы и комментарии к ним;

- описание программы – информация о логической структуре и функционировании программы;

- программа и методика испытаний – перечень и описание требований, которые должны быть проверены в ходе испыта­ния программы, методы контроля;

- техническое задание – документ, в котором излагаются на­значение и область применения программы, требования к ПС, стадии и сроки разработки, виды испытаний;

- пояснительная записка – обоснование принятых и приме­ненных технических и технико-экономических решений, схе­мы и описание алгоритмов, общее описание работы ПС.

К программным документам отнесены также документы, обес­печивающие функционирование и эксплуатацию программ – экс­плуатационные документы:

- ведомость эксплуатационных документов – содержит список эксплуатационных документов на ПИ, к которым относятся формуляр, описание применения, руководство системного про­граммиста, руководство программиста, руководство оператора, описание языка, руководство по техническому обслуживанию;

- формуляр – содержит основные характеристики ПИ, состав и сведения об эксплуатации программы;

- описание применения – содержит информацию о назначе­нии и области применения ПИ, ограничениях при примене­нии, классе и методах решаемых задач, конфигурации техни­ческих средств;

- руководство системного программиста – содержит сведения для проверки, настройки и функционирования программы при конкретном применении;

- руководство программиста – содержит сведения для эксплуа­тации ПИ;

- руководство оператора – содержит подробную информацию для пользователя, обеспечивающую его общение с ЭВМ в процессе выполнения ПИ;

- описание языка – содержит синтаксис и семантику языка;

- руководство по техническому обслуживанию – содержит све­дения для применения тестовых и диагностических программ при обслуживании технических средств.

Необходимость составления остальных документов устанавливается при разработке и утверждении технического зада­ния (ТЗ).

Кроме формуляра и ведомости допускается объединять отдель­ные виды эксплуатационных документов. Например, часто разраба­тывают документ, называемый «Руководство пользователя», в кото­рый включают различные сведения из руководства системного про­граммиста, руководства программиста и оператора. «Руководство пользователя» должно учитывать все требования инструкций, необ­ходимых пользователю и содержать, как правило, общие сведения о ПИ, описание установки и запуска, подробные инструкции по ра­боте, т. е. описание режимов работы, форматов ввода-вывода ин­формации, различных настроек и другой необходимой информации для пользователя.

Большую роль для унификации при программировании играет стандарт ГОСТ 19.701-90 (ИСО 5807-85) «Схемы алгоритмов, про­грамм, данных и систем», где приведены условные обозначения в схемах алгоритмов, программ, данных и систем, устанавливаются правила выполнения схем для решения различных задач. В этом стандарте описаны последовательности описания схем:

- данных (отображают путь данных, этапы обработки, носители);

- программы (отображают последовательность операций в про­грамме);

- работы системы (отображают управление операциями и поток
данных в системе);

- взаимодействия программ (отображают путь активаций про­грамм и взаимодействий с соответствующими данными);

- ресурсов системы (отображают конфигурацию блоков: дан­ных и обрабатывающих).

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

Виды эксплуатационных документов и их содержание