Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 32 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Скилл для Claude, который превращает неструктурированное описание процесса в читаемую BPMN 2.0 схему (Camunda 7, Platform) и — по запросу — в Excel-спецификацию, сверенную со схемой.

**Версия:** 2.3.0
**Версия:** 2.3.1
**Автор:** Andrey Zagreev — [@zagreev](https://t.me/zagreev)
**Лицензия:** [MIT](#лицензия)
**Целевая платформа:** Camunda 7 (Platform)
Expand All @@ -20,7 +20,7 @@
- [Требования](#требования)
- [Установка](#установка)
- [Типовой сценарий использования](#типовой-сценарий-использования)
- [Как работает внутри (9 шагов)](#как-работает-внутри-9-шагов)
- [Как работает внутри (11 шагов)](#как-работает-внутри-11-шагов)
- [Что внутри архива](#что-внутри-архива)
- [Что гарантировано](#что-гарантировано)
- [Чего скилл НЕ делает](#чего-скилл-не-делает)
Expand Down Expand Up @@ -50,7 +50,7 @@
- Все подписи на русском, продуктовые и бренд-названия сохраняются как есть
- Текстовые аннотации на схеме для SLA, регуляторных ссылок, бизнес-правил и открытых вопросов
- Автоматический выбор топологии (пулы / лэйны / плоская) и декомпозиции (иерархия с подпроцессами, если узлов больше 9)
- 7 блокирующих проверок корректности XML + 10 рекомендательных best practices перед показом
- 7 блокирующих проверок корректности XML + 11 рекомендательных best practices перед показом

**После одобрения схемы** — Excel-спецификация:

Expand Down Expand Up @@ -115,7 +115,7 @@ Clarification Wizard — шаг перед генерацией BPMN. Он ищ
**Что происходит в degraded mode (MCP недоступен, скилл работает на snapshot):**
- Генерация XML, валидация, Excel-экспорт идут как обычно
- Перед вопросом одобрения схемы скилл явно предупреждает, что использован snapshot
- В заголовке XML указано `<!-- Camunda knowledge: snapshot v1.0 (2026-04-23) -->`
- В заголовке XML указано `<!-- Camunda knowledge: snapshot v1.0 (2026-04-26) -->`
- Перед prod-деплоем рекомендуется активировать MCP и перегенерировать, либо свериться с live docs вручную

## Установка
Expand All @@ -135,15 +135,15 @@ Clarification Wizard — шаг перед генерацией BPMN. Он ищ
3. Claude отдаёт:
- Классификацию (отрасль, участники, выбранная топология, выбранная декомпозиция)
- XML-код схемы (или несколько файлов, если иерархия)
- Отчёт о прохождении 7 валидаций + статус 10 рекомендательных best practices
- Отчёт о прохождении 7 валидаций + статус 11 рекомендательных best practices
- Список открытых вопросов, которые нужно уточнить
- Вопрос: «Схема корректна? После подтверждения могу выгрузить спецификацию в Excel»
4. Открываете XML в Camunda Modeler, проверяете
5. Если нужны правки — пишете их Claude, получаете обновлённую схему
6. Если всё ок — пишете «да» / «выгружай» / «сделай таблицу»
7. Claude генерирует `.xlsx`, прогоняет 9 проверок сверки, показывает статус-отчёт, отдаёт файл

## Как работает внутри (9 шагов)
## Как работает внутри (11 шагов)

0. **Классификация входа** — text-only, mixed input, zeebe namespace, unsupported format или invalid XML
1. **Загрузка документации Camunda** через MCP — синтаксис BPMN, extension-элементы, паттерны пулов, аннотации, сабпроцессы
Expand All @@ -152,7 +152,7 @@ Clarification Wizard — шаг перед генерацией BPMN. Он ищ
3. **Выбор топологии** по правилу: несколько организаций → collaboration с пулами; один бизнес с ролями → пул с лэйнами; один актёр → плоский процесс
4. **Выбор декомпозиции** по правилу 7±2: больше 9 узлов или 2+ уровня вложенных шлюзов → overview + drill-down подпроцессы
5. **Генерация BPMN XML** в UTF-8, с русскими подписями, BPMN DI, Camunda extensions, текстовыми аннотациями для SLA / регуляторки / открытых вопросов
6. **Валидация XML**: 7 блокирующих проверок (well-formedness, BPMN schema, структурная целостность + infinite loop + event references + boundary events + duplicate IDs + subprocess types + data objects, message flows + collaboration, Camunda 7 executability, DI completeness, соответствие русского языка) + 10 рекомендательных best practices (technical ID naming, happy path, business vs technical errors, sentence case и др.)
6. **Валидация XML**: 7 блокирующих проверок (well-formedness, BPMN schema, структурная целостность + infinite loop + event references + boundary events + duplicate IDs + subprocess types + data objects, message flows + collaboration, Camunda 7 executability, DI completeness, соответствие русского языка) + 11 рекомендательных best practices (technical ID naming, happy path, business vs technical errors, sentence case и др.)
7. **Показ пользователю**: классификация + XML + отчёт валидации + открытые вопросы + вопрос про Excel
8. **Excel-выгрузка** (только после одобрения схемы) в UTF-8, с цветовой кодировкой типов BPMN, скрытой колонкой `_BPMN_ID` для сверки
9. **Сверка Excel ↔ BPMN** — 9 проверок: количество узлов, ID-маппинг, названия, лэйны, правила на шлюзах, итоги на end-событиях, аннотации, порядок выполнения, UTF-8. Статус показывается перед выдачей файла
Expand All @@ -164,8 +164,8 @@ bpmn-process-modeler/
├── README.md — это описание
├── SKILL.md — основная логика скилла
└── references/
├── bpmn-patterns.md — 8 готовых XML-паттернов (approval loop, 4-eyes, параллельное согласование, таймерная эскалация, компенсация, B2B-обмен сообщениями, DMN, event-based gateway)
├── camunda-knowledge-snapshot.md — fallback-snapshot Camunda docs на случай недоступности MCP (~1170 строк, версия 1.0 от 2026-04-23); BPMN 2.0 + Camunda 7 extensions + DI + best practices + методология построения (happy path first, explicit modeling, декомпозиция, anti-patterns)
├── bpmn-patterns.md — 10 готовых XML-паттернов (approval loop, 4-eyes, параллельное согласование, таймерная эскалация, компенсация, B2B-обмен сообщениями, DMN, event-based gateway, documentation pattern, glossary annotation pattern)
├── camunda-knowledge-snapshot.md — fallback-snapshot Camunda docs на случай недоступности MCP (~1170 строк, версия 1.0 от 2026-04-26); BPMN 2.0 + Camunda 7 extensions + DI + best practices + методология построения (happy path first, explicit modeling, декомпозиция, anti-patterns)
├── industry-patterns/ — отраслевые паттерны, по одному файлу на domain; модель читает ТОЛЬКО соответствующий файл на Step 2
│ ├── fintech-patterns.md — 17 процессов: KYC / KYB / Seller KYB / BaaS onboarding / Payment auth / 3DS / P2P / Chargeback / Refund / BNPL / Collection / Leasing / Factoring / Seller lending / RBF (Merchant Cash Advance) / Settlement-payout / Regulatory reporting
│ ├── marketplace-patterns.md — 5 процессов: Order-to-cash / Returns / Pick-Pack-Ship / Seller discovery / Cross-border marketplace
Expand All @@ -179,7 +179,7 @@ bpmn-process-modeler/
├── clarification-wizard.md — правила Wizard: missing-facts categories, вопросы, assumption mode
├── input-classification.md — Step 0 routing: text-only, mixed input, rejects, invalid XML
├── reuse-id-rules.md — правила сохранения ID при обновлении существующего BPMN
├── validation-checklist.md — 7 блокирующих проверок XML с Python-кодом + 10 рекомендательных best practices (на основе Camunda bpmnlint и docs)
├── validation-checklist.md — 7 блокирующих проверок XML с Python-кодом + 11 рекомендательных best practices (на основе Camunda bpmnlint и docs)
├── excel-spec-template.md — 9-колоночный шаблон + worked example на BNPL
└── reconciliation-procedure.md — 9 проверок сверки Excel и BPMN с openpyxl-кодом
```
Expand Down Expand Up @@ -229,7 +229,7 @@ bpmn-process-modeler/

**Camunda MCP не подключается.** Проверьте в Settings → Connectors, что URL указан точно: `https://camunda-docs.mcp.kapa.ai`. Перезапустите чат, иногда connector-сессия истекает. Если проблема сохраняется — убедитесь, что у вас актуальный план Claude.ai (MCP доступен на Pro и выше). **Если MCP недоступен — скилл продолжит работать на локальном snapshot** (`references/camunda-knowledge-snapshot.md`), но перед prod-деплоем рекомендуется активировать MCP и перегенерировать XML, либо свериться с live docs. Скилл явно предупредит в выводе, когда работает в degraded mode.

**XML не открывается в Camunda Modeler — «пустой холст».** Обычно означает проблему с BPMN DI. Запросите у Claude: «Проверь DI в XML — не все ли узлы имеют BPMNShape?». Скилл пересоберёт DI-секцию. Если проблема сохраняется — приложите XML и скриншот Modeler в чат, Claude попросит фрагмент ошибки.
**XML не открывается в Camunda Modeler — «пустой холст».** Обычно означает проблему с BPMN DI. Запросите у Claude: «Проверь DI в XML — все ли узлы имеют BPMNShape?». Скилл пересоберёт DI-секцию. Если проблема сохраняется — приложите XML и скриншот Modeler в чат, Claude попросит фрагмент ошибки.

**Excel частично на английском.** Не должно случаться — 10-я проверка reconciliation ловит это и автоматически правит. Если всё же пролетело: укажите Claude, какие именно ячейки на английском (лист, колонка, значение) — перегенерирует с корректным переводом.

Expand All @@ -252,7 +252,26 @@ bpmn-process-modeler/

## Changelog

### v2.3.0 — дата релиза TBD
### v2.3.1 — 27 апреля 2026

Documentation hygiene patch.

- Исправлены даты snapshot Camunda docs в README: `2026-04-23` → `2026-04-26` (2 места) — соответствует фактическому `snapshot_date` в `SKILL.md` frontmatter и `references/camunda-knowledge-snapshot.md`.
- Исправлено количество BPMN-паттернов в описании архива: `8 готовых XML-паттернов` → `10` (добавлены `documentation pattern` и `glossary annotation pattern` в перечисление).
- Исправлено количество рекомендательных best practices в актуальных секциях: `10` → `11` (включён ранее пропущенный `naming and readability` — секция 8 в `validation-checklist.md`). Затронуты разделы «Что делает», «Как работает внутри» Step 6, «Типовой сценарий», Changelog v2.0. Исторические секции v1.0 / v1.1 не изменялись.
- Заголовок «Как работает внутри (9 шагов)» → «(11 шагов)» — учтены добавленные в v2.3.0 Step 0 (Input classification) и Step 1.5 (Clarification Wizard).
- Исправлена опечатка в Troubleshooting: «не все ли узлы имеют BPMNShape?» → «все ли узлы имеют BPMNShape?» (лишнее «не» меняло смысл фразы на противоположный).
- Подставлена фактическая дата релиза v2.3.0: `27 апреля 2026` (вместо placeholder `TBD`) в README и RELEASE.md.
- Добавлено 6 новых release-тестов в `tests/release/test_metadata.py`, защищающих от drift между README и source-of-truth файлами:
- `test_changelog_release_date_is_filled` — блокирует публикацию, если дата текущей версии в changelog осталась `TBD` или `<дата...>`.
- `test_historic_changelog_dates_are_filled` — защищает исторические секции changelog от регрессии на `TBD` после merge conflict.
- `test_readme_snapshot_date_matches_frontmatter` — синхронизирует обе упоминания snapshot-даты в README со `snapshot_date` из `SKILL.md` frontmatter.
- `test_readme_bpmn_patterns_count_matches_source` — синхронизирует число «N готовых XML-паттернов» в README с фактическим числом `## N.` секций в `references/bpmn-patterns.md`.
- `test_readme_best_practices_count_matches_validation_checklist` — синхронизирует число «N рекомендательных best practices» в актуальных секциях README с числом optional-секций (≥ 8) в `references/validation-checklist.md`.
- `test_release_md_has_current_version_section` — требует наличие pre-release checklist для текущей версии в `RELEASE.md`.
- Поведение генерации BPMN, валидации, Wizard, reuse-ID и Excel-выгрузки не изменялось.

### v2.3.0 — 27 апреля 2026

Wizard-only minor release.

Expand Down Expand Up @@ -313,7 +332,7 @@ Release hygiene patch.

Валидация и качество:
- 7 блокирующих проверок XML: well-formedness, BPMN schema conformance, structural integrity (10 подпунктов: sequence flows, start/end events, reachability, gateway fan-in/out, infinite loops, event references, boundary events, duplicate IDs, subprocess types, data objects), message flows и collaboration, Camunda 7 executability, DI completeness, language conformance
- 10 рекомендательных best practices (на основе Camunda bpmnlint и docs): technical ID naming, business-side event labels, business vs technical errors, happy path emphasis, sentence case, один executable process в collaboration, alignment имени файла с process ID, unused resources, empty process, circular call activity detection
- 11 рекомендательных best practices (на основе Camunda bpmnlint и docs): naming and readability, technical ID naming, business-side event labels, business vs technical errors, happy path emphasis, sentence case, один executable process в collaboration, alignment имени файла с process ID, unused resources, empty process, circular call activity detection
- 9 проверок reconciliation Excel ↔ BPMN перед выдачей файла: node count parity, ID-level mapping, name parity, lane/pool parity, gateway decision rules, end event outcomes, annotation coverage, execution order sanity, UTF-8 integrity

Excel-спецификация:
Expand Down
20 changes: 19 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,25 @@ Release tags must be signed with an SSH signing key registered on the releasing

## Pre-release checklist

### v2.3.0 — release date TBD
### v2.3.1 — release date TBD

Release scope: documentation hygiene patch (no behavior changes).

Required local checks:
- `python3 -m unittest discover -s tests/release -v`
- All existing release tests must pass.
- The 6 new tests in `tests/release/test_metadata.py` must pass for v2.3.1:
- `test_changelog_release_date_is_filled`
- `test_historic_changelog_dates_are_filled`
- `test_readme_snapshot_date_matches_frontmatter`
- `test_readme_bpmn_patterns_count_matches_source`
- `test_readme_best_practices_count_matches_validation_checklist`
- `test_release_md_has_current_version_section`

No new test modules in v2.3.1. Existing module `tests/release/test_metadata.py`
gets six new test methods.

### v2.3.0 — 2026-04-27

Release scope:
- Step 0 input classification
Expand Down
2 changes: 1 addition & 1 deletion SKILL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: bpmn-process-modeler
description: Converts prose, transcripts, notes, process memos, or mixed text + existing BPMN into valid BPMN 2.0 XML for Camunda Platform 7, with Russian labels and optional Excel specification. Use when the user asks to model, draw, map, diagram, convert to BPMN/Camunda/.bpmn/XML, create pools and lanes, export an Excel process table, уточни процесс перед моделированием, обнови существующий BPMN, дополни BPMN, расширь схему, or генерируй с допущениями. The skill classifies input, loads Camunda docs, runs the Wizard when needed, validates XML, asks for approval, then exports a reconciled UTF-8 Excel specification.
version: 2.3.0
version: 2.3.1
snapshot_version: 1.0
snapshot_date: 2026-04-26
snapshot_expiry: 2026-10-23
Expand Down
Loading
Loading