В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).
4.5 Руководство программиста
Руководство программиста должно содержать следующие части:
- назначение и условия применения программы;
- характеристики программы;
- обращение к программе;
- входные и выходные данные;
- сообщения.
В зависимости от особенностей документа допускается объединять отдельные части или вводить новые.
В части «Назначение и условия применения программы» указываются назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т. п.).
В части «Характеристики программы» приводится описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.).
В части «Обращение к программе» приводится описание процедуры вызова программы (способы передачи управления и параметров данных и др.).
В части «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и при необходимости ее кодирования.
В части «Сообщения» указываются тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).
4.6 Руководство оператора
Руководство оператора должно содержать следующие части:
- назначение программы;
- условия выполнения программы;
- выполнение программы;
- сообщения оператору.
В зависимости от особенностей документа допускается объединять отдельные части или вводить новые.
В части «Назначение программы» указываются сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.
В части «Условия выполнения программы» указываются условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратных и программных средств и т. п.).
В части «Выполнение программы» указывается последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
В части «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т. п.).
Допускается содержание частей иллюстрировать поясняющими примерами, таблицами, схемами, графиками.
В приложение к руководству оператора могут входить различные материалы, которые нецелесообразно включать в части руководства.
В пояснительной записке к дипломному проекту (работе) допускается объединять руководство системного программиста, руководство программиста и руководство оператора в руководство пользователя с коррекцией содержимого объединяемых документов для исключения дублирования содержащихся в них сведений.
4.7 Текст программы
Документ состоит из одной или нескольких частей, которым дают наименования.
Допускается вводить наименования и для совокупности частей.
Каждая из этих частей реализуется одним из типов символической записи, например:
- символическая запись на исходном языке;
- символическая запись на промежуточных языках;
- символическое представление машинных кодов.
В начале каждой части документа рекомендуется указывать:
- назначение части;
- содержание части;
- процедуры, функции и другие компоненты программы, которые включены в данную часть, место их использования.
В первой части дополнительно рекомендуется приводить:
- наименование программы;
- обозначение программы;
- используемые для написания программы языки программирования;
- перечень и краткое описание выполняемых функций;
- перечень обозначений функций и процедур, которые включены в данную программу;
- перечень обозначений и краткое описание используемых функций и процедур, вызываемых из других программ или системных библиотек;
- перечень и типы глобальных переменных и констант;
- правила образования имен (идентификаторов) переменных, констант, функций, процедур или ссылка на документ, в котором эти правила установлены;
- перечень входных и выходных данных с пояснением их смысла в терминах предметной области, для использования в которой предназначена программа.
В частях документа объединяют модули, реализованные на одном языке программирования, или функции, процедуры и другие компоненты программы, обеспечивающие решение отдельной задачи, и т. д.
При реализации модулей, функций, процедур и других компонентов программы необходимо, чтобы:
- обращения к одной функции в разных частях программы использовали единый способ восстановления информации вызвавшей ее программы;
- процедуры возврата управления из функций и процедур были единообразными;
- программы, написанные на одном языке программирования, использовали единый способ восстановления информации вызвавшей ее программы;
- процедуры и функции, написанные на одном языке, единообразным способом передавали значения в вызвавшую их процедуру или функцию;
- каждая функция и процедура имели одну точку входа и одну точку выхода;
- в циклах для параметра, начального и конечного значений диапазона его изменения были использованы переменные одного типа;
- каждый цикл имел один вход и один выход;
- не использовались «бесконечные» циклы;
- число переходов по условию было минимизировано;
- не использовались условные операторы и циклы с большой глубиной вложенности;
- не использовались операторы безусловной передачи управления, особенно если они нарушают направление выполнения операторов;
- в логических (булевых) выражениях переменные и соответствующие им операции располагались в порядке уменьшения их влияния на возможность получения отрицательного результата;
- каждая глобальная переменная была объявлена явно во всех модулях, где она используется.
В символическую запись модулей, функций, процедур и других компонентов программы рекомендуется включать комментарии:
- к определениям функций и процедур;
- к интерфейсам;
- к группам функционально или каким-либо другим способом связанных описаний;
- к труднопонимаемым частям программы;
- к операторам ветвления;
- к машинозависимым частям программы;
- к точкам выхода из функций и процедур.
Текст комментария должен давать дополнительную информацию, облегчающую понимание программы или ее части, назначение и способ использования ее элементов, а не повторять текст оператора.
При реализации модулей, функций, процедур и других компонентов программы на исходном языке программирования рекомендуется соблюдать следующие правила:
- в одной строке должен быть записан не более чем один оператор;
- в циклах и условных операторах должны быть использованы отступы и комментарии, позволяющие выделять группы операторов, выполняемых в данном цикле, или ветви условного оператора передачи управления.
5 ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ
ГРАФИЧЕСКОЙ ЧАСТИ
5.1 Общие положения
Графический материал дипломного проекта (работы) представляется в виде чертежей, схем, графиков и т. д. формата А1. Содержание чертежей определяется видом дипломного проекта (конструкторский, технологический, исследовательский).
Для защиты дипломных проектов рекомендуются следующие виды чертежей, схем, графиков:
- схемы функциональной, организационной и технической структуры системы;
- сетевые графики и временные диаграммы;
- схемы алгоритмов;
– схема программного обеспечения.
Графический материал дипломного проекта должен быть оформлен в соответствии с ЕСКД, а также требованиями действующих ГОСТов. Графический материал (схемы, перечень элементов) может выноситься в приложения. Не допускается пояснять работу алгоритма (алгоритмов) в тексте записки, ссылаясь на графический материал приложений. Должны быть приведены все необходимые поясняющие рисунки в самом тексте пояснительной записки.
Обозначение документа в основной надписи производится в соответствии со следующей схемой:
XXХХ X XXX XXX XX, ,
1 2 3 4 5
где 1 – РТДП – для дипломных проектов; РТКП – для курсовых проектов;
2 – индекс иерархии документа (от 0 до 8);
3 – условное обозначение изделия по классификатору;
4 – порядковый номер документа (например 003 – третий документ);
5 – индекс чертежа: СС – схема структуры системы; СГ – сетевые графики; СА– схема алгоритма, СП – схема программного обеспечения и т. д.
Наименование и код схем определяют их видом и типом.
Код схемы должен состоять из буквенной части, определяющей вид схемы, и цифровой части, определяющей тип схемы.
5.2 Правила выполнения схем алгоритмов и программ
Схемы алгоритмов, программ, данных и систем (далее – схемы) состоят из имеющих заданное значение символов, краткого пояснительного текста и соединяющих линий.
Символы используются в схемах данных, схемах программ, схемах работы системы, схемах взаимодействия программ и в схемах ресурсов системы.
Приведем определения основных понятий.
Основной символ – символ, используемый в тех случаях, когда точный тип (вид) процесса или носителя данных неизвестен или отсутствует необходимость в описании фактического носителя данных.