СТ БПИ-03-98

МИНИСТЕРСТВО ОБРАЗОВАНИЯ РЕСПУБЛИКИ БЕЛАРУСЬ

Брестский политехнический институт

Стандарт института

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

в курсовых и дипломных проектах (работах)

Общие требования к разработке и правила оформления

СТ БПИ ‑ 03 ‑ 98

Брест 1998

Содержание

Стр.

1. Область применения……………………………………….…… 3

2. Нормативные ссылки………………………………………….. 3

3. Определения……………………………...………………………... 3

4. Общие требования………………………………………….….… 3

4.1. Виды программ и программных документов……………………. 4

4.2. Обозначения и основные надписи программных документов…. 5

4.3. Общие требования к структуре программных документов…….. 7

5. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ ТЕКСТОВЫХ ПРОГРАММНЫХ ДОКУМЕНТОВ………………… 9

5.1. Спецификация……………………………………………………. 9

5.2. Техническое задание……………………………………………… 10

5.3. Текст программы…………………………………………………. 11

5.4. Описание программы…………………………………………….. 11

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

5.6. Пояснительная записка…………………………………………... 13

5.7. Описание применения……………………………………………. 14

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

5.9. Руководство программиста………………………………………. 15

5.10. Руководство оператора………………………………………….. 16

6. ТРЕБОВАНИЯ К ВЫПОЛНЕНИЮ ГРАФИЧЕСКИХ ПРОГРАММНЫХ ДОКУМЕНТОВ………………………………… 16

6.1. Виды графических программных документов…………………. 16

6.2. Определение символов графической идентификации функций 17

6.3. Правила применения графических символов………………….. 20

ПРИЛОЖЕНИЕ 1 …………………………………………………….. 22

ПРИЛОЖЕНИЕ 2 …………………………………………………….. 23

СТАНДАРТ ПРЕДПРИЯТИЯ

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

Дата введения 1998-09-01

ОБЛАСТЬ ПРИМЕНЕНИЯ

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

Стандарт предназначен для студентов и преподавателей института.

НОРМАТИВНЫЕ ССЫЛКИ

В настоящем стандарте использованы ссылки на государственные стандарты комплекса класса 19 ‑ Единой системы программной документации.

ОПРЕДЕЛЕНИЯ

ПРОГРАММА. Последовательность команд (набор операторов, записанный на некотором языке программирования), представляемая как единое целое и используемая для управления поведением ЭВМ в соответствии с требуемым алгоритмом.

АЛГОРИТМ. Заданная последовательность четко определенных правил (команд) для получения решения задачи за конечное число шагов.

ПРОГРАММНЫЙ ДОКУМЕНТ. Текстовый или графический документ, содержащий сведения, необходимые для разработки, изготовления, передачи, сопровождения и эксплуатации программы.

Общие требования

Общие требования настоящего стандарта установлены в соответствии с ГОСТ 19.101-77, 19.103-77, 19.104-78, 19.105-78, 19.106-78.

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

4.1.1. Программные изделия (программы) идентифицируют и применяют самостоятельно и (или) в составе других программ и подразделяют на виды:

• компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса;

• комплекс – программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.

4.1.2. Виды, коды и общее содержание важнейших программных документов разработки и изготовления:

• спецификация – состав программы и документации на нее;

• техническое задание – код 00 – назначение и область применения программы, технические, технико-экономические и специальные требования к программе, стадии и сроки разработки, виды испытаний, требования к составу программной документации;

• текст программы – код 12 – символическая запись программы с необходимыми комментариями;

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

• программа и методика испытаний – код 51 – требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля;

• пояснительная записка – код 81 – общее описание алгоритма и функционирования программы, обоснование принятых технических и технико-экономических решений;

• схема (схема алгоритма) программы (данных, системы) – код 90 (91,92) – графическое представление задач обработки данных, методов и средств их решения.

Виды и общее содержание важнейших программных документов сопровождения и эксплуатации:

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

• руководство системного программиста – код 32 – сведения для проверки и настройки программы на условия конкретного применения;

• руководство программиста (оператора) – код 33 (34) – сведения для эксплуатации программы, обеспечения процедуры общения с вычислительной системой.

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

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