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

Традиционно введение содержит:

• Актуальность решаемой в ВКР проблемы
• Цель работы
• Задачи
• Объект исследования
• Предмет исследования
• Практическая значимость работы

Введение может также включать

• Научная значимость работы
• Опубликованные работы по теме ВКР

В данном разделе необходимо с помощью литературы:

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

В данном разделе дается развернутая постановка задачи, решаемой в ВКР. Сама постановка это по сути развернутое и уточнение предложение вида “Необходимо сделать …, при этом результат должен обладать следующим набором свойств: 1) …, 2)….”. При этом, постановка задачи должна по смыслу полностью перекликаться с целью/задачами во Введении.

Обоснование постановки задачи (требований к решению) можно дать либо в данном либо в предыдщуем разделе.

Решением может быть:

• программа (как самостоятельное приложение, так и модуль/патч/драйвер и т.д.)
• алгоритм
• метод

В данном разделе необходимо подробно описать и обосновать созданное в рамках ВКР решение / метод решения. Традиционно раздел может включають в себя:

• мат.аппарат
  • используемые формализации
  • ваши разработки
    • формальная запись
    • границы применимости
• архитектура программной реализации
  • алгоритмы
    • блок-схема или псевдокод
    • входные и выходные данные алгоритма
  • сценарии использования
  • используемые технологии
  • структура программной реализации
    • классы / модули / функции
    • как структурные элементы программы связаны / взаимодействую друг с другом - текст и графическая схема
    • как программа взаимодействует с другими системами - текст и графическая схема
  • интерфейс пользователя (пользователями могут быть не только люди, но и другие программы)
    • Виды:
      • командная строка
      • веб-интерфейс
      • REST-интерфейс
      • GUI
      • сетевой протокол
    • Что необходимо описать:
      • общие правила взаимодействия
      • процедура авторизации
      • назначение отдельных команд, ключей командной строки, запросов, экранов приложения
      • последовательность использования интерфейса ( с каких команд необходимо начинать и т.д.)
      • примеры запросов для REST-интерфейсов, командной строки, сетевых протоколов и пр.
  • модель данных
    • технологии хранения (используемые СУБД)
    • ER-диаграммы
    • назначение и состав отдельных коллекций (таблиц)
      • какие документы хранятся
      • как выглядит схема данных
      • связи между коллекциями и их реализация
      • примеры хранимых данных
      • ограничения

В заключении необходимо:

• кратко описать были ли решены задачи, поставленные во Введении, и показать конкретные результаты решения каждой задачи,
• отметить были ли достигнута цель работы, поставленная во Введении.