5.2. Оформление текста программы

Текст программы или его часть в пояснительной записке к ВКР оформляются в соответствии с ГОСТ 19.401-78 [15].

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

Каждый из этих модулей реализуется одним из типов символической записи:

─символическая запись на исходном языке;

─символическая запись на промежуточных языках;

─символическое представление машинных кодов и т. п.

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

5.3. Документация, разрабатываемая на программу

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

Состав программной документации определен в ГОСТ 19.101-77 [12].

К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ (табл. 1, табл. 2).

Таблица 1

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

Вид программного документа

Содержание программного документа

Спецификация

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

Ведомость держателей подлинников

Перечень предприятий, на которых хранят подлинники программных документов

Текст программы

Запись программы с необходимыми комментариями

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

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

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

Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля

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

Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний

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

Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений

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

Сведения для обеспечения функционирования и эксплуатации программы

Таблица 2

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

Вид эксплуатационного документа

Содержание эксплуатационного

документа

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

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

Формуляр

Основные характеристики программы, комплектность и сведения об эксплуатации программы

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

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

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

Сведения для проверки, обеспечения функционирования и настройки программы

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

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

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

Сведения для обеспечения процедуры общения оператора с вычислительной системой

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

Описание синтаксиса и семантики языка

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

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

6. Оформление элементов текста

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