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