Главная

Категории:

ДомЗдоровьеЗоологияИнформатикаИскусствоИскусствоКомпьютерыКулинарияМаркетингМатематикаМедицинаМенеджментОбразованиеПедагогикаПитомцыПрограммированиеПроизводствоПромышленностьПсихологияРазноеРелигияСоциологияСпортСтатистикаТранспортФизикаФилософияФинансыХимияХоббиЭкологияЭкономикаЭлектроника






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


СТАНДАРТ ИНСТИТУТА

 

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

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

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

 

СТ БПИ ‑ 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.1. Программные изделия (программы) идентифицируют и применяют самостоятельно и (или) в составе других программ и подразделяют на виды:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Спецификация

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

Основная часть спецификации содержит текст, разбитый на графы:

– «Обозначение» ‑ для обозначений основных и дополнительных программных документов данного комплекса, а также входящих в него комплексов и компонентов;

– «Наименование» ‑ для наименований разработанных и заимствованных документов на данный комплекс, полных наименований программы и основного документа для входящих комплексов и компонентов;

– «Примечание» ‑ для дополнительных сведений, относящихся к записанным документам и программам.

Ширина граф, соответственно ‑ 80, 70 и 30 мм, высота строк – 7..10 мм.

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

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

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

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

Техническое задание на разработку учебных программных изделий оформляется в виде «Задания на курсовое (дипломное) проектирование» по соответствующим формам и правилам и включается в пояснительную записку листом со вторым порядковым номером.

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

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

Текст программы

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

Для лучшего представления структуры программы запись текста программы рекомендуется (а в случае использования нескольких языков программирования – необходимо) оформлять в виде нескольких разделов с соответствующими наименованиями (заголовками), с отражением этого в содержании документа. Если запись текста программы состоит из одного раздела, то ему также присваивается заголовок, но содержание не составляется.

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

Описание программы

Документ включает следующие разделы основной части, содержащие необходимую информацию:

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

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

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

используемые технические и программные средства – типы, характеристики ЭВМ и устройств, а также перечень других программ (программных пакетов), которые необходимы для работы программы;

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

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

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

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

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

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

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

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

методы испытаний – последовательное описание используемых проверок (тестовых примеров) с указанием контрольных результатов.

Пояснительная записка

Составление информационной части является обязательным. Содержание включает: номера и заголовки разделов, подразделов основной части с номерами листов (страниц); номера и наименования приложений (при наличии). Содержание размещают на отдельной (нумерованной) странице (страницах) перед разделом введения и снабжают не нумерованным заголовком СОДЕРЖАНИЕ. Пояснительная записка к дипломному проекту (работе) должна содержать также аннотацию, которую размещают на отдельной (нумерованной) странице перед содержанием и снабжают не нумерованным заголовком АННОТАЦИЯ. В аннотации кратко (не более 20 строк текста) излагают назначение и содержание разработки, указывают объем документа, количество рисунков (иллюстраций), таблиц, использованных источников (литературы), приложений.

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

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

(нумеруемый раздел) ‑ анализ технического задания (постановка задачи на разработку), результаты патентно-информационного поиска, обоснование выбранных для разработки концепций, математических методов и языков программирования;

(нумеруемый раздел) – обоснование и описание структуры (схемы) программы, системы (ресурсов системы), взаимодействия программ и систем, выбора состава технических и программных средств;

(нумеруемый раздел) – обоснование выбора и описание разработанных алгоритмов, методов организации входных и выходных данных, распределения носителей данных, описание функционирования программы;

(нумеруемый раздел) – анализ результатов тестирования и испытания программы;

(нумеруемый раздел) – расчет технико-экономических показателей раз­работки, обосновывающий преимущества выбранного технического решения;

выводы; заключение (не нумеруемые разделы);

список использованной литературы (не нумеруемый раздел) – перечень книг, описаний, статей, нормативных документов и других научно-технических материалов, на которые есть ссылки в тексте основных разделов.

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

Описание применения

Документ включает следующие разделы основной части, содержащие необходимую информацию:

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

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

описание задачи – определения решаемых задач, применяемые методы их решения;

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

Руководство программиста

Документ включает следующие разделы основной части, содержащие необходимую информацию:

назначение и условия применения программы – назначение, выполняемые функции, условия выполнения (объем оперативной памяти, требуемое программное обеспечение, состав и параметры периферийных устройств);

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

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

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

Руководство оператора

Документ включает следующие разделы основной части, содержащие необходимую информацию:

назначение и условия применения программы – назначение программы, информация о выполняемых функциях и условиях выполнения (минимальный и/или максимальный состав аппаратурных и программных средств);

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

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

Требования к выполнению графических программных документов

Графические программные документы выполняют в соответствии с ГОСТ 19.701-90.

Символы данных

а ‑ данные – общее обозначение, носитель данных не определен;

б ‑ запоминаемые данные – хранимые данные, носитель данных не определен;

(в, г, д) ‑ запоминающее устройство (оперативное; с последовательным доступом; с прямым доступом) – данные, хранящиеся в запоминающем устройстве соответствующего типа;

е (ж, з) ‑ документ (карта; бумажный носитель) – данные, представленные в удобочитаемом виде на неопределенном носителе (либо на магнитной карте или перфокарте; либо на бумажном носителе);

и ‑ ручной ввод – данные, вводимые вручную с соответствующих устройств;

к ‑ дисплей – данные в читаемой форме на отображающем устройстве.

Символы процесса

л ‑ процесс – функция обработки данных любого вида (общее обозначение);

м ‑ предопределенный процесс – состоящий из нескольких операций (шагов) процесс, который определен в подпрограмме или в модуле;

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

о ‑ ручная операция – процесс, выполняемый человеком вручную;

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

р ‑ граница цикла – две части символа отображают начало и конец цикла, условия приращения или завершения цикла помещаются, соответственно, внутри первой или второй части;

с ‑ параллельные действия – синхронизация двух или более параллельных операций.

 

Символы линий

т ‑ линия – поток данных или управления, при необходимости добавляются стрелки-указатели направления потока;

у ‑ передача управления – передача управления от одного процесса к другому, тип передачи (постоянная, временная, прерывание) должен быть назван внутри символа (соответственно, условными обозначениями P, T, I );

ф ‑ канал связи – передача данных по внешнему каналу связи;

х ‑ пунктирная линия – альтернативная связь между символами; также ограничение (обведение) смысловых участков (блоков).

 

Специальные символы

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

ч ‑ терминатор – выход во внешнюю среду и вход из внешней среды (указатель начала или конца схемы или ее законченной части);

ш ‑ комментарий – добавление записей (комментариев) в целях объяснения, описания, примечания соответствующего символа или обведенной группы символов.

СТАНДАРТ ИНСТИТУТА

 

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

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

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

 

СТ БПИ ‑ 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.1. Программные изделия (программы) идентифицируют и применяют самостоятельно и (или) в составе других программ и подразделяют на виды:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



Последнее изменение этой страницы: 2016-07-22

headinsider.info. Все права принадлежат авторам данных материалов.