
- •Стандарт института
- •Содержание
- •Общие требования
- •4.1. Виды программ и программных документов
- •4.2. Обозначения и основные надписи программных документов
- •4.3. Общие требования к структуре программных документов
- •Требования к содержанию и оформлению текстовых программных документов
- •5.1. Спецификация
- •5.2. Техническое задание
- •5.3. Текст программы
- •5.4. Описание программы
- •5.5. Программа и методика испытаний
- •5.6. Пояснительная записка
- •5.7. Описание применения
- •5.8. Руководство системного программиста
- •5.9. Руководство программиста
- •5.10. Руководство оператора
- •Требования к выполнению графических программных документов
- •6.1. Виды графических программных документов
- •6.2. Определение символов графической идентификации функций
- •6.2.1. Символы данных
- •6.2.2. Символы процесса
- •6.2.3. Символы линий
- •6.2.4. Специальные символы
- •6.3. Правила применения графических символов
5.4. Описание программы
Документ включает следующие разделы основной части, содержащие необходимую информацию:
общие сведения – обозначение и наименование программы, необходимое для ее функционирования программное обеспечение, использованные при разработке языки программирования;
функциональное назначение – классы (виды) решаемых задач, сведения о функциональных ограничениях на применение;
описание логической структуры – описание алгоритма и используемые методы (краткая характеристика, если имеется подробное описание в пояснительной записке и разработана схема алгоритма); структура программы, функции и взаимосвязи составных частей; связи программы с другими программами;
используемые технические и программные средства – типы, характеристики ЭВМ и устройств, а также перечень других программ (программных пакетов), которые необходимы для работы программы;
вызов и загрузка – способ вызова программы с соответствующего носителя данных, входные точки в программу, адреса загрузки, сведения об использовании оперативной памяти и объеме программы;
входные и выходные данные – характер, организация, формат и способ кодирования входных и выходных данных, предварительная подготовка входных данных.
5.5. Программа и методика испытаний
Составление информационной части является необязательным. Основная часть документа должна включать следующие разделы, содержащие необходимую информацию:
объект и цель испытаний – наименование, обозначение и область применения испытуемой программы, цель проведения испытаний;
требования к программе – требования, подлежащие проверке во время испытаний и приведенные в техническом задании, в том числе специальные требования;
требования к программной документации – состав программной документации, направляемой на испытания;
средства и порядок испытаний – используемые во время испытаний технические и программные средства, порядок проведения испытаний;
методы испытаний – последовательное описание используемых проверок (тестовых примеров) с указанием контрольных результатов.
5.6. Пояснительная записка
Составление информационной части является обязательным. Содержание включает: номера и заголовки разделов, подразделов основной части с номерами листов (страниц); номера и наименования приложений (при наличии). Содержание размещают на отдельной (нумерованной) странице (страницах) перед разделом введения и снабжают не нумерованным заголовком СОДЕРЖАНИЕ. Пояснительная записка к дипломному проекту (работе) должна содержать также аннотацию, которую размещают на отдельной (нумерованной) странице перед содержанием и снабжают не нумерованным заголовком АННОТАЦИЯ. В аннотации кратко (не более 20 строк текста) излагают назначение и содержание разработки, указывают объем документа, количество рисунков (иллюстраций), таблиц, использованных источников (литературы), приложений.
Основная часть пояснительной записки должна включать следующие основные разделы, содержащие необходимую информацию:
введение (не нумеруемый раздел) – краткая характеристика области применения программного изделия и его основных технических параметров, сведения о внедрении (использовании);
(нумеруемый раздел) ‑ анализ технического задания (постановка задачи на разработку), результаты патентно-информационного поиска, обоснование выбранных для разработки концепций, математических методов и языков программирования;
(нумеруемый раздел) – обоснование и описание структуры (схемы) программы, системы (ресурсов системы), взаимодействия программ и систем, выбора состава технических и программных средств;
(нумеруемый раздел) – обоснование выбора и описание разработанных алгоритмов, методов организации входных и выходных данных, распределения носителей данных, описание функционирования программы;
(нумеруемый раздел) – анализ результатов тестирования и испытания программы;
(нумеруемый раздел) – расчет технико-экономических показателей разработки, обосновывающий преимущества выбранного технического решения;
выводы; заключение (не нумеруемые разделы);
список использованной литературы (не нумеруемый раздел) – перечень книг, описаний, статей, нормативных документов и других научно-технических материалов, на которые есть ссылки в тексте основных разделов.
Нумеруемые разделы могут состоять из нумеруемых подразделов, пунктов и т.д., наименьший структурно-логический элемент текста – не нумеруемый абзац. Наименования нумеруемых разделов стандартом не устанавливаются, должны быть лаконичными, отражающими изложенную в разделе информацию и определяются самостоятельно разработчиком (предлагаются руководителем разработки) в зависимости от назначения и содержания разработки.