6.6 Введение

6.6.1 Введение помещают в текстовый документ, начиная с новой страницы, после перечня условных обозначений, если такой имеется, а при его отсутствии – непосредственно после содержания.

6.6.2 Во введении кратко излагают:

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

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

– цель работы и область применения;

– взаимосвязь с другими работами.

6.6.3 Раздел «ВВЕДЕНИЕ» выполняют на листах с рамкой и основной надписью согласно 5.1.5.

6.6.4 Наименование структурного элемента «ВВЕДЕНИЕ» оформляют в соответствии с 5.3 как заголовок раздела, последующий текст – согласно указаниям раздела 5.

6.7 Суть текстового документа

6.7.1 Суть текстового документа помещают в текстовый документ, начиная с новой страницы непосредственно после введения.

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

6.7.3 Суть текстового документа излагают, разделяя материал на части, как это указано в 5.2.

6.7.4 Если КР направлена на создание программного продукта, то в суть текстового документа включают следующие разделы: «ОПИСАНИЕ ПРОГРАММЫ» и «РУКОВОДСТВО ОПЕРАТОРА».

6.7.5 Описание программы выполняют в соответствии с ГОСТ 19.402-78.

6.7.5.1 Описание программы должно содержать следующие разделы:

– общие сведения;

– функциональное назначение;

– описание логической структуры;

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

– вызов и загрузка;

– входные данные;

– выходные данные.

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

6.7.5.2 В разделе “Общие сведения” должны быть указаны: – наименование программы; – программное обеспечение, необходимое для функционирование программы; – языки программирования, на которых написана программа.

6.7.5.3 В разделе “Функциональное назначение” должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.

6.7.5.4 В разделе “Описание логической структуры” должны быть указаны:

– алгоритм программы;

– используемые методы;

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

– связи программы с другими программами.

Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

6.7.5.5 В разделе “Используемые технические средства” должны быть указаны:

– технические требования к ПЭВМ: тип процессора, емкость ОЗУ, наличие свободного места на жестком диске, тип монитора и др.;

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

6.7.5.6 В разделе “Вызов и загрузка” должны быть указаны: способ вызова программы с соответствующего носителя данных, сведения об использовании оперативной памяти, объем программы.

6.7.5.7 В разделе “Входные данные” должны быть указаны: характер, организация и предварительная подготовка входных данных; формат, описание входных данных

6.7.5.8 В разделе “Выходные данные” должны быть указаны: характер и организация выходных данных; формат, описание выходных данных.

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

6.7.6 Руководство оператора выполняют в соответствии с ГОСТ 19.505-79.

6.7.6.1 Руководство оператора должно содержать следующие разделы:

– назначение программы;

– условия выполнения программы;

– выполнение программы;

– сообщения оператору.

В зависимости от особенностей программы документы допускается объединять отдельные разделы или вводить новые.

6.7.6.2 В разделе “Назначение программы” должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.

6.7.6.3 В разделе “Условия выполнения программы” должны быть указаны условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратурных и программных средств и т.п.).

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

6.7.6.5 В разделе “Сообщения оператору” должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).

6.7.6.6 Содержание разделов руководства оператора необходимо иллюстрировать поясняющими примерами, таблицами, схемами, графиками.

6.7.7. В текстовом документе следует использовать единицы СИ.

6.7.8 Ответственность за достоверность сведений, содержащихся в текстовом документе, несет автор (студент), составивший текстовый документ.

6.7.9 Суть текстового документа оформляют согласно указаниям раздела 5.