mirror of
https://github.com/StepanovPlaton/SSAUGenerator.git
synced 2026-10-31 10:18:29 +04:00
Fix title-docx
This commit is contained in:
24
AGENTS.md
24
AGENTS.md
@@ -24,6 +24,9 @@
|
||||
- **Создание — только через `--init`.** Новый проект создавайте командами с флагом
|
||||
`--init` (см. ниже): они формируют правильную структуру и общий каталог
|
||||
ресурсов.
|
||||
- **Сначала план — потом работа.** Прежде чем наполнять проект, составьте план и
|
||||
сохраните его в `content/<проект>/PLAN.md` (см. раздел «Планирование проекта»).
|
||||
Работу над содержимым начинайте только после согласования плана с пользователем.
|
||||
- **Имя результата = имя проекта.** Документ и презентация собираются в папку
|
||||
проекта, а имя файла совпадает с именем проекта:
|
||||
`content/<проект>/<проект>.docx` и `content/<проект>/<проект>.pptx`.
|
||||
@@ -43,7 +46,8 @@ ssau-generator/
|
||||
│ └── example/
|
||||
│ ├── assets/ # общие ресурсы проекта (для docx и pptx)
|
||||
│ ├── docx/ # config.yaml + *.md
|
||||
│ └── pptx/ # config.yaml + slides/
|
||||
│ ├── pptx/ # config.yaml + slides/
|
||||
│ └── PLAN.md # согласованный план проекта
|
||||
├── AGENTS.md # этот файл
|
||||
└── README.md
|
||||
```
|
||||
@@ -59,6 +63,24 @@ ssau-generator/
|
||||
- Папки `content/*` добавлены в `.gitignore`; в репозитории хранится только
|
||||
`content/example/`. Рабочие проекты пользователя коммитить не нужно.
|
||||
|
||||
## Планирование проекта
|
||||
|
||||
Перед наполнением проекта составьте план и сохраните его в
|
||||
`content/<проект>/PLAN.md`. План создаётся **до** работы над `config.yaml` и
|
||||
Markdown и согласуется с пользователем. В плане укажите:
|
||||
|
||||
- **реквизиты** — студент (ФИО), группа, дисциплина;
|
||||
- **тему** работы и её цель;
|
||||
- **структуру** — разделы и подразделы с названиями и пунктами (для документа —
|
||||
по `sections`, для презентации — список слайдов);
|
||||
- **краткое содержание** каждого раздела/слайда;
|
||||
- **список источников** — если согласован с пользователем;
|
||||
- **нюансы** — особые требования пользователя (объём, оформление, сроки,
|
||||
ограничения и т.п.), если они указаны;
|
||||
- прочие согласованные детали.
|
||||
|
||||
Пример готового плана — `content/example/PLAN.md`.
|
||||
|
||||
## Создание нового проекта
|
||||
|
||||
Проект создаётся командами с флагом `--init` — они формируют структуру и общие
|
||||
|
||||
Reference in New Issue
Block a user