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

Все программные документы оформляются на листах формата А4 или A3 без рамки и основной надписи. Вверху посередине листа документа проставля­ется номер страницы и обозначения документа. Внизу дается строка изменений.

Спецификация (без кода) — основной программный документ, устанавли­вающий состав программы и документации на нее ГОСТ 19.202. Она является обязательной для комплексов и компонентов, имеющих самостоятельное приме­нение. В спецификации в общем случае должны быть разделы: документация, комплексы и компоненты. Заголовки подчеркивают. После каждого раздела спе­цификации оставляют несколько свободных строк (не менее одной) для допол­нительных записей. В графе «Примечание» указывают дополнительные сведе­ния, относящиеся к записанным в спецификации программам.

Текст программы (код 12) — обязательный программный документ для компонентов (для компонентов, не имеющих спецификации, он является основ­ным документом) по ГОСТ 19.401. Информационная часть в документе является обязательной. Запись текстов в основной части документа реализуется одним из типов символической записи: на исходном языке, символическое представление кодов и т. п.

Пример оформления документа представлен на рисунке 7.5.

Описание программы (код 13) — программный документ, который состав­ляется на компоненты и комплексы и содержит следующие разделы: общие све­дения, функциональное назначение, описание логической структуры, используе­мые логические средства, вызов и загрузка, входные данные, выходные данные (ГОСТ 19.402).

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

В разделе «Входные данные» указывают характер, организацию и предвари­тельную подготовку входных данных, формат, описание и способ их кодирова­ния, а в разделе «Выходные данные» — характер и организацию выходных дан­ных, их формат, описание и способ кодирования.

Пояснительная записка (код 81) входит в состав документов на стадиях разработки эскизного и технического проектов программы (ГОСТ 19.404). Доку­мент содержит схему алгоритма, общее описание алгоритма и (или) функциони­рование программы, а также обоснование принятых технико-экономических ре­шений. Пояснительная записка должна содержать разделы: введение; назначе­ние и область применения; технические характеристики; ожидаемые технико-экономические показатели; источники, используемые при разработке.

С ЗАПИСЬ ПРОГРАММЫ РЕШЕНИЯ КВАДРАТНОГО УРАВНЕНИЯ НА АЛГОРИТМИЧЕСКОМ ЯЗЫКЕ FORTRAN-4 REAL A,B,C,D

1 READ(l.l) A,D,C

PRINT 2,A,B,C

2 FORMAT(5X,'A=',F8,3,5X,'B=',F8.3,5X,'C=',F8. 3)

IF(A.NE.O) GOTO 5 IF(B.NE.O) GOTO 4 IF(C.NE.O) GOTO 3

С КОРНЕЙ БЕСКОНЕЧНОЕ МНОЖЕСВО IC=4 GOTO 8

3 IC5

С КОРНЕЙ НЕТ

GOTO 8

С ОДИН КОРЕНЬ 4Х1=С/В

D=X1**2-C/A

IF(D.GT.O) GOTO 7

IF(D.LT.O) GOT06 С РАВНЫЕ ВЕЩЕСТВЕННЫЕ КОРНИ

IС=1

Х2=Х1 GOTO 8

6 D=SQRT(D)

С КОМПЛЕКСНЫЕ КОРНИ IС=2 GOTO 8

7 D=SQRT(-D)

С РАЗЛИЧНЫЕ ВЕЩЕСТВЕННЫЕ КОРНИ X2=X1-D X1=X1+D IC=0

8 PRINT 9,IC

9 FORMAT(5X,'TИП РЕШЕНИЯ=',12)

IF(IC.GE.4) GOTO 11

PRINT 10.X1.X2

10 FORMAT(10X,'X1=',E8.3,5X,'X2=',E8.3) 11 RETURN END

Рисунок 7.5 — Запись алгоритма решения задачи на языке ФОРТРАН-IV

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

Пример оформления схемы алгоритма для нахождения корней квадратного урав­нения (текст программы алгоритма см. на рисунке 7.5) приведен на рисунке 7.6.

Комплект документов по автоматизированному проектированию (в пособии не приводится) оформляется на выводных устройствах, автоматическом цифро­вом печатающем устройстве и с помощью графопостроителя выводится исполни­телем. Оформление документов регламентируется ГОСТ 2.004.

Рисунок 7.6 — Схема алгоритма решения вычислительной задачи (уравнения ах² + bх+ с = 0)