818a044aa1
Python application / build (push) Has been cancelled
- update документация - промт для ии полу конфигурируемый
34 lines
2.2 KiB
Markdown
34 lines
2.2 KiB
Markdown
# Промпты для ИИ
|
||
|
||
Промпты лежат в [`prompts/`](../prompts/). В GUI: **Справка → Промпт для ИИ** — выбрать, при необходимости **дописать схемы**, скопировать в буфер. Полная документация также доступна в **Справка → Документация** (вшита в exe).
|
||
|
||
## Какие файлы
|
||
|
||
| Файл | Когда |
|
||
|------|--------|
|
||
| [`generate-md.md`](../prompts/generate-md.md) | Базовый: диалект md2gost, чем отличается от обычного MD; UML/Mermaid рисует конвертер |
|
||
| [`generate-mirea-report.md`](../prompts/generate-mirea-report.md) | Полный отчёт ГОСТ / МИРЭА (`coursework`, `practice`, `vkr`) |
|
||
| [`generate-pis-custom-report.md`](../prompts/generate-pis-custom-report.md) | Итоговый отчёт ПИС (`PIS_custom`) |
|
||
|
||
## Как пользоваться
|
||
|
||
1. Откройте промпт (файл или GUI).
|
||
2. В GUI включите нужные схемы (C4, BPMN, …) — в конец промпта добавятся макросы и `ai-prompt` из `md2gost.schemes.json`.
|
||
3. Скопируйте собранный текст в ChatGPT / Claude / Cursor / Copilot.
|
||
4. Следующим сообщением: тип работы, тема, черновик / требования.
|
||
5. Сохраните ответ как `.md` и конвертируйте:
|
||
|
||
```bash
|
||
python -m md2gost report.md -o report.docx --type coursework --check --strict
|
||
```
|
||
|
||
## Зачем кнопки схем
|
||
|
||
Базовый промпт уже говорит: блоки `` ```uml `` / `` ```mermaid `` / `` ```uml-c4 `` конвертер сам превратит в Рисунок. Кнопки нужны, когда модели надо знать **конкретные макросы** выбранной схемы (Person/Rel для C4, Start/XOR/Flow для BPMN и т.д.) — в том числе пользовательских из «Шаблоны UML».
|
||
|
||
## Подробнее о синтаксисе
|
||
|
||
- [markdown.md](markdown.md)
|
||
- [schemes.md](schemes.md)
|
||
- [prompts/README.md](../prompts/README.md)
|