10.3 Программная документация

Комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации, составляет Единую систему программной документации (ЕСПД).

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

К программным документам относятся (ГОСТ 19.101-77):

1) спецификация, содержащая сведения о составе программы и документации на нее;

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

3) текст программы, включающий запись программы с необходимыми комментариями;

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

5) программа и методика испытаний;

6) техническое задание;

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

8) эксплуатационные документы, к которым относятся формуляр, руководство системного программиста, руководство программиста, руководство оператора, описание языка и др.

При выполнении схем алгоритмов и программ отдельные функции отображаются в виде условных графических обозначений — символов (ГОСТ 19.003-80).

Наиболее употребляемые символы для отображения функций показаны на рис. 10.8.

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

Символ «Решение» используется для указания направления процесса в зависимости от некоторых условий (условный арифметический и логический оператор).

Символ «Модификация» говорит

Рис. 10.8. Обозначение символов в схемах алгоритмов и программ: а — процесс; б - решение: в — модификация; г - предопределенный процесс; д - пуск — останов; е - комментарий; ж - соединитель; е - межстраничный соединитель

Рис. 10.9. Использование соединителей: а — на одной странице; б - межстраничный

о выполнении операций, меняющих команды или группы команд, изменяющих программу (оператор цикла)

Символ «Предопределенный процесс» применяется при использовании ранее созданных и отдельно описанных алгоритмов или программ (оператор вызова продпрограмм).

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

Символ «Комментарий» применяется, если пояснение не помещается внутри графического символа. Символ помещают на свободном месте схемы алгоритма и соединяют с поясняемым символом.

Символы «Соединитель» и «Межстраничный соединитель» используются для указания связи между разъединенными частями алгоритма при большой насыщенности схемы символами. Примеры нанесения символов на оборванные линии потока показаны на рис. 10.9.

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

Размеры символов назначаются из следующих соображений.

Рис. 10.10. (см. скан) Обозначение ввода-вывода данных в алгоритмах и программах: а — ручной, б - преобразования; в — документ; г - перфокарта; д - перфолента; е - магнитная лента; ж - магнитный барабан; э - дисплей; и — магнитная карта; к — магнитный диск; л - оперативная память

Меньший геометрический размер символа (за исключением соединителей пуска — останова, комментария выбирается из ряда 10, 15, 20...мм. Соотношение большего и меньшего размеров должно составлять 1,5. Расположение символов на схеме (за исключением межстраничного соединителя) должно соответствовать приведенному на рис. 10.8 и 10.10. Межстраничный символ может располагаться вертикально и горизонтально.

Правила выполнения схем алгоритмов и программ, выполняемых автоматизированным способом или от руки, устанавливает ГОСТ 19.002-80.

Схемы должны быть выполнены на листах стандартного формата по ГОСТ 2.301-68.

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

Каждый символ должен иметь обозначение, которое помещается в разрыве контура символа. Обозначение символа может состоять из координат зоны листа, в которой размещен символ (см. рис. 10.9), или иметь порядковый номер (рис. 10.11).

Линии потока, связывающие символы, должны быть параллельны линиям рамки формата листа. Направление линий потока сверху вниз и слева направо принято за основное и стрелками не обозначается. В остальных случаях направление линий обозначать стрелкой обязательно. Расстояние между параллельными линиями потока должно быть не менее 3 мм, между остальными символами — не менее 5 мм (рис. 10.11).

Общие требования к оформлению программных документов для вычислительных машин, комплексов и систем для любого способа выполнения устанавливает ГОСТ 19.105-78.

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

Содержание программного документа разделяется на следующие условные части: а) титульную; б) информационную; в) основную; г) регистрацию изменений.

Рис. 10.11. Схема алгоритма

Выполнение печатного программного документа (ГОСТ 19.106-78) осуществляется одним из следующих способов:

а) машинописным — на одной стороне листа через два интервала;

б) машинным — на одной стороне листа, пригодным к микрофильмированию;

в) типографским.

Материалы программного документа располагают в определенной последовательности:

титульная часть: лист утверждения, титульный лист;

информационная часть: аннотация, лист содержания;

основная часть: текст документа (с рисунками, таблицами и т. д.);

часть регистрации изменений: лист регистрации изменений.

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

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

Для компонентов, не имеющих спецификации, основным программным документом является «Текст программы».

Спецификация в общем случае должна содержать разделы: а) документация; б) комплексы; в) компоненты.

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

Далее записывают заимствованные программные документы. Запись производится в порядке возрастания кодов организаций -разработчиков и далее в порядке возрастания кода документа, входящего в обозначение документа (см. ГОСТ 19.101-77, ГОСТ 19.103-77).