write chapter_3

This commit is contained in:
2026-04-01 14:00:38 +03:00
parent 26f2fac07b
commit 2561ba1cbf
21 changed files with 557 additions and 18 deletions

View File

@@ -2,29 +2,45 @@
## Общие требования
Писать понятно, четко и ясно.
Писать понятно, четко и ясно. Избегать избыточности и воды.
## Технические файлы
Файлы для поддержания структуры работы:
- `readme.md` — оглавление в виде таблицы
- `instruction.md` — правила написания
- `instruction.md` — правила написания (этот файл)
- `todo.md` — текущие задачи
- `_todo_backlog.md` — предложения на будущее
- `_*.md` — вспомогательные файлы (_style.md, _references.md и т.д.)
- `_plan.md` — план главы/раздела
## Структура
## Структура папок
Технические файлы короткие и понятные. Поддерживать сжатую структуру в процессе написания.
## Контент
- Основной текст диссертации — в папках chapters
- Основной текст — в папках chapters
- Медиафайлы (картинки, схемы) — в `_media/`
- Использовать ссылки на изображения в формате `![описание](../_media/image.png)`
- Главы содержат подпапки для крупных разделов
## Соглашения
## Соглашения по тексту
- Аббревиатуры расшифровывать при первом упоминании
- Формулы нумеровать
- Рисунки подписывать
- Формулы нумеровать: `(1)`, `(2)` и т.д.
- Рисунки подписывать: `Рисунок 1 Описание`
- Таблицы нумеровать и давать заголовки
- Ссылки на изображения: `![описание](../_media/image.png)`
## Соглашения по картинкам
- Только студент может вставлять ссылку на медиафайл.
- Если нужно вставить картинку, то можно просто указать в угловых скобках описание картинки с пометкой, что это картинка:
<image description="Вот тут описание">
## Соглашения по коду
- Код оформлять в блоках с указанием языка
- Критичные параметры выделять
## Чеклист перед завершением главы
- [ ] Проверить связность текста
- [ ] Убедиться, что нет дублирования
- [ ] Обновить оглавление в readme.md
- [ ] Перенести выполненные задачи в backlog