Хотел сделать систему, чтобы при нажатии одной кнопки создавались все доки. Но это оказалось труднее, чем думал. Тем не менее, получился довольно неплохой "заполнитель", который точно ускорит написание документации 😵💫
Что вам надо сделать для запуска в терминале:
1. Установить через brew программу и Typst:
```shell
brew tap vasyukov1/hse-coursework-docs
brew install term-paper
brew install typst
```
Команда помощник: term-paper help
2. Инициализировать проект: term-paper init
3. Появятся файлы с конфигурацией, в которые надо внести свои данные и положить файлик с ТЗ и архив с репозиторием.
4. Выполнить генерацию, например, term-paper generate-doc --doc pz
5. При необходимости подправить текст в папке docs/<doc_name>
6. Конвертировать Typst в PDF: term-paper create-pdf --doc pz
>>> Более подробно описано в README.md.
Работает через API key вашей ИИ, который устанавливаете в конфиге, пишете ключ, модель и радуетесь жизни. Всё работает локально, ничего не утечёт, исходники есть тут и тут.
🥳 Основная сложность — могут быстро закончится токены, если используете бесплатную модель с OpenRouter, поэтому лучше для каждого документа создавать отдельный API key и в архиве, ТЗ оставлять только необходимое, чтобы не засорять контекст.
Также есть возможность сделать только шаблон (без ИИ), который можно заполнить самим.
🚲 Если есть идеи, как улучшить, пишите или делайте PR — буду рад помощи