В содержании указывают обозначение и наименование всех разделов, подразделов, пунктов и номера страниц, на которых размещается начало материала разделов, подразделов, пунктов. В содержание включают также имеющиеся приложения с указанием их номеров и заголовков.
При обращении к Вашей работе ее, как правило, будут изучать в следующей последовательности:
- реферат;
- введение и заключение;
- постановку задачи;
- остальные разделы основной части;
- при необходимости углубленного ознакомления с техническими деталями – приложения.
Соответственно этому формируется содержание каждого раздела.
Ниже приведен пример заполнения содержания пояснительной записки:
| СОДЕРЖАНИЕ ЗАДАНИЕ НА ПРОЕКТИРОВАНИЕ…………………………… - РЕФЕРАТ………………………………………………………….. 3 ПЕРЕЧЕНЬ ЛИСТОВ ГРАФИЧЕСКИХ ДОКУМЕНТОВ…….. 4 ПЕРЕЧЕНЬ УСЛОВНЫХ ОБОЗНАЧЕНИЙ И СИМВОЛОВ… 5 ВВЕДЕНИЕ………………………………………………………… 6 1. ПОСТАНОВКА ЗАДАЧИ…………………………………….… 10 2. ОБЗОР СУЩЕСТВУЮЩИХ ПРОГРАММНЫХ СРЕДСТВ.. 14 3. ИНФОРМАЦИОННАЯ СТРУКТУРА СИСТЕМЫ…………… 17 3.1. Каналы ввода-вывода……………………………………… 18 3.2. Диаграммы сущность-связь ………………………………. 22 3.3. Структура таблиц базы данных…………………………… 26 3. ИНТЕРФЕЙС ПОЛЬЗОВАТЕЛЯ…………………………….. 35 4. СХЕМЫ И ОПИСАНИЯ АЛГОРИТМОВ……………………. 44 5. ИНСТРУКЦИЯ ПОЛЬЗОВАТЕЛЯ…………………………… 49 6. ИНСТРУКЦИЯ ПРОГРАММИСТА…………………………… 54 7. МЕТОДИКА И РЕЗУЛЬТАТЫ ТЕСТИРОВАНИЯ………….. 60 8. ЭКОНОМИЧЕСКАЯ ЧАСТЬ…………………………………… 68 9. БЕЗОПАСНОСТЬ И ЭКОЛОГИЧНОСТЬ ПРОЕКТА………. 75 9.1.Безопасность проекта………………………………………… 75 9.2.Экологичность проекта………………………………………. 78 9.3.Прогнозирование чрезвычайных ситуаций………………. 92 ЗАКЛЮЧЕНИЕ……………………………………………………... 98 ПРИЛОЖЕНИЕ 1. Тексты программ…………………………… 102 ПРИЛОЖЕНИЕ 2. Тексты запросов к базе данных…………. 108 СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ……………… 112 2 |
Реферат представляет собой сокращенное изложение существа работы. В реферате отражаются характер, цель, методика проведения и конкретные результаты работы, вывод, области возможного применения результатов. Указываются код УДК, объем пояснительной записки, количество рисунков, таблиц, библиографических описаний, приложений, а также ключевые слова для автоматизированного поиска. Таким образом, реферат состоит из формального описания документа (код УДК, автор, название, ключевые слова, параметры документа) и текстовой аннотации его содержания.
Оптимальный объем реферата не более 2000 знаков.
Пример реферата:
РЕФЕРАТ
УДК 004.17
Бочков О.М. АРМ проверки безопасности информационной системы «Security Monitor».
Пояснительная записка, 61 стр, 20 рис., 6 табл., 17 источников, 2 прил.
БЕЗОПАСНОСТЬ ИНФОРМАЦИОННОЙ СИСТЕМЫ, ПРОВЕРКА ЦЕЛОСТНОСТИ, АУДИТ ПАРОЛЕЙ, АТАКИ НА ПАРОЛЬНУЮ СИСТЕМУ, ВЗЛОМ.
Разработан программный продукт, позволяющий контролировать целостность информационной системы организации и надежность паролей пользователей информационной системы в сети Windows NT. Программа позволяет с заданной периодичностью и по команде проводить «атаку по словарю» и «атаку грубой силы» на парольную систему и контролировать целостность как всей информационной системы, так и самой программы. Для хэширования на выбор могут использоваться алгоритмы ГОСТ, MD5, SHA.
2.6. Перечень условных обозначений, символов, единиц и терминов
Этот перечень составляют при необходимости. В перечень включают специфические, малораспространенные, допускаемые к применению в технической литературе сокращения и новые символы и т.п., не расшифрованные в формулах. В перечень не включаются условные обозначения, символы, повторяющиеся в тексте менее трех раз; их расшифровывают в тексте при первом упоминании.
Перечень располагают столбцом: слева, в алфавитном порядке, приводят сокращения, символы, а справа – детальную их расшифровку и размерность.
2.7. Перечень листов графических документов
Он составляется по следующей форме:
ПЕРЕЧЕНЬ ЛИСТОВ ГРАФИЧЕСКИХ ДОКУМЕНТОВ
| № п/п | Наименование документа | Обозначение документа | Формат |
| 1 | Автоматическая линия для сварки трубопроводов. Планировка | 12.05 041212 210 В0 | А1 |
| … | … | … | … |
| 6 | Центратор. Сборочный чертеж | 12.05 296242 210 СБ | А1 |
| 7 | Установка для сварки арматуры. Схема электрическая принципиальная | 12.05 683124 210 ЭЗ | А1 |
Во введении дают оценку современного состояния решаемой в проекте научно-технической проблемы, приводят исходные данные для разработки, обоснование необходимости выполнения проекта; показывают актуальность и новизну темы.
2.9. Основная часть пояснительной записки
В основной части излагаются постановка задачи, последовательность и результаты ее решения. Заголовок «Основная часть» не пишется. В дипломных проектах (работах) в состав основной части входят также вспомогательные разделы экономики, безопасности жизнедеятельности и т.д.
Постановка задачи – это подробное развернутое задание на выполнение работы. В ней должно содержаться описание функций разрабатываемого объекта, количественные и качественные показатели его функционирования. Могут также присутствовать дополнительные требования (например, к электробезопасности, условиям среды и т.д.). Если работа является исследовательской, описываются цели исследования, формы представления результатов и пр.
За постановкой задачи может следовать либо теоретический раздел, либо результаты системного анализа объекта – его место в системе более высокого уровня, формы взаимодействия со смежными объектами и другие общесистемные вопросы. Раздел может также включать отчет или результат НИРС (УИРС), выполненных по теме проекта.
Крайне маловероятно, что Ваша работа является абсолютно пионерской и что в этой области никто никогда не работал до Вас. Поэтому обязательно должен присутствовать раздел, посвященный обзору существующих технических решений (возможно с включением сюда патентного поиска). Вы должны показать, почему существующие решения (аппаратура, программы, методы) не могут полностью решить поставленную перед Вами задачу. Далее должны следовать выбор Ваших собственных решений и его обоснование.
Затем следует изложение результатов Вашей конкретной работы. Содержание соответствующих разделов и последовательность изложения определяются характером работы и не могут здесь быть точно регламентированы. Обычно для проектов, связанных с разработкой аппаратуры, принят следующий порядок изложения: описания структурной, функциональной и принципиальной схем, чертежи печатных плат, чертежи общего вида, сборочные чертежи, временные диаграммы сигналов, алгоритмы встроенного программного обеспечения и коды прошивок ПЗУ, результаты испытаний и т.д. Для работ программистского характера приводят информационную структуру системы, описание среды разработки, протоколы обмена, схемы и описания алгоритмов, структуры таблиц базы данных, тексты запросов, интерфейсы пользователя, инструкции пользователя, оператора, программиста и системного программиста, описание применения программы, тексты программ и их описания, методику и результаты тестирования. Чертежи и схемы оформляют в соответствии с требованиями стандартов Единой системы конструкторской документации (ЕСКД), программные документы - в соответствии с требованиями Единой системы программной документации (ЕСПД). Подробные схемы, чертежи и полные тексты программ рекомендуется выносить в приложения.
Разделы основной части пояснительной записки разбивают на подразделы и пункты. Пункты при необходимости могут быть разбиты на подпункты.
Разделы должны иметь порядковую нумерацию в пределах всей основной части, подразделы – в пределах раздела, пункты – в пределах подраздела, подпункты – в пределах каждого пункта. В конце номеров разделов, подразделов, пунктов и подпунктов ставят точку, например 1.2.2. (пункты), 1.2.1а.; 1.2.1б. (подпункты). Более глубокая рубрикация не рекомендуется.
При небольшом объеме пояснительной записки новый раздел допускается начинать на листе, где заканчивается предыдущий.
Все иллюстрирующие материалы пояснительной записки (рисунки, чертежи, схемы, диаграммы, графики, фотографии) называют рисунками. Рисунки выполняют машинным способом, карандашом, одноцветной тушью или пастой (черной, синей, фиолетовой) на листах пояснительной записки или на листах чертежей, миллиметровой бумаги формата А4. Допускается выполнение на листах формата А3.
Рисунки на чертеже или миллиметровой бумаге, фотографии и т.д. допускается наклеивать на листы пояснительной записки.