autopilot/dissertation/instruction.md

Инструкция по написанию диссертации

Общие требования

Писать понятно, четко и ясно. Избегать избыточности и воды.

Технические файлы

Файлы для поддержания структуры работы:

• readme.md — оглавление в виде таблицы
• instruction.md — правила написания (этот файл)
• todo.md — текущие задачи
• _todo_backlog.md — предложения на будущее
• _*.md — вспомогательные файлы (_style.md, _references.md и т.д.)
• _plan.md — план главы/раздела

Структура папок

• Основной текст — в папках chapters
• Медиафайлы (картинки, схемы) — в _media/
• Главы содержат подпапки для крупных разделов

Соглашения по тексту

• Аббревиатуры расшифровывать при первом упоминании
• Формулы нумеровать: (1), (2) и т.д.
• Рисунки подписывать: Рисунок 1 – Описание
• Таблицы нумеровать и давать заголовки
• Ссылки на изображения: ![описание](../_media/image.png)

Соглашения по картинкам

• Только студент может вставлять ссылку на медиафайл.
• Если нужно вставить картинку, то можно просто указать в угловых скобках описание картинки с пометкой, что это картинка:

Соглашения по коду

• Код оформлять в блоках с указанием языка
• Критичные параметры выделять

Чеклист перед завершением главы

• Проверить связность текста
• Убедиться, что нет дублирования
• Обновить оглавление в readme.md
• Перенести выполненные задачи в backlog