Refactor README and command documentation to streamline deployment and CI/CD processes. Consolidate deployment strategies and remove obsolete commands related to CI/CD and observability. Enhance task decomposition workflow by adding data model and deployment planning sections, and update directory structures for improved clarity.

2026-04-22 09:16:38 +00:00 · 2026-03-19 12:10:11 +02:00
parent 5b1739186e
commit cfd09c79e1
17 changed files with 1314 additions and 313 deletions
@@ -1,7 +1,7 @@
 ---
 name: plan
 description: |
-  Decompose a solution into architecture, system flows, components, tests, and Jira epics.
+  Decompose a solution into architecture, data model, deployment plan, system flows, components, tests, and Jira epics.
  Systematic 6-step planning workflow with BLOCKING gates, self-verification, and structured artifact management.
  Uses _docs/ + _docs/02_plans/ structure.
  Trigger phrases:
@@ -15,7 +15,7 @@ disable-model-invocation: true

 # Solution Planning

-Decompose a problem and solution into architecture, system flows, components, tests, and Jira epics through a systematic 6-step workflow.
+Decompose a problem and solution into architecture, data model, deployment plan, system flows, components, tests, and Jira epics through a systematic 6-step workflow.

 ## Core Principles

@@ -91,6 +91,13 @@ PLANS_DIR/
 │   └── traceability_matrix.md
 ├── architecture.md
 ├── system-flows.md
+├── data_model.md
+├── deployment/
+│   ├── containerization.md
+│   ├── ci_cd_pipeline.md
+│   ├── environment_strategy.md
+│   ├── observability.md
+│   └── deployment_procedures.md
 ├── risk_mitigations.md
 ├── risk_mitigations_02.md          (iterative, ## as sequence)
 ├── components/
@@ -124,6 +131,8 @@ PLANS_DIR/
 | Step 1 | Integration traceability matrix | `integration_tests/traceability_matrix.md` |
 | Step 2 | Architecture analysis complete | `architecture.md` |
 | Step 2 | System flows documented | `system-flows.md` |
+| Step 2 | Data model documented | `data_model.md` |
+| Step 2 | Deployment plan complete | `deployment/` (5 files) |
 | Step 3 | Each component analyzed | `components/[##]_[name]/description.md` |
 | Step 3 | Common helpers generated | `common-helpers/[##]_helper_[name].md` |
 | Step 3 | Diagrams generated | `diagrams/` |
@@ -210,9 +219,11 @@ Capture any new questions, findings, or insights that arise during test specific
 ### Step 2: Solution Analysis

 **Role**: Professional software architect
-**Goal**: Produce `architecture.md` and `system-flows.md` from the solution draft
+**Goal**: Produce `architecture.md`, `system-flows.md`, `data_model.md`, and `deployment/` from the solution draft
 **Constraints**: No code, no component-level detail yet; focus on system-level view

+#### Phase 2a: Architecture & Flows
+
 1. Read all input files thoroughly
 2. Incorporate findings, questions, and insights discovered during Step 1 (integration tests)
 3. Research unknown or questionable topics via internet; ask user about ambiguities
@@ -230,6 +241,56 @@ Capture any new questions, findings, or insights that arise during test specific

 **BLOCKING**: Present architecture summary to user. Do NOT proceed until user confirms.

+#### Phase 2b: Data Model
+
+**Role**: Professional software architect
+**Goal**: Produce a detailed data model document covering entities, relationships, and migration strategy
+
+1. Extract core entities from architecture.md and solution.md
+2. Define entity attributes, types, and constraints
+3. Define relationships between entities (Mermaid ERD)
+4. Define migration strategy: versioning tool (EF Core migrations / Alembic / sql-migrate), reversibility requirement, naming convention
+5. Define seed data requirements per environment (dev, staging)
+6. Define backward compatibility approach for schema changes (additive-only by default)
+
+**Self-verification**:
+- [ ] Every entity mentioned in architecture.md is defined
+- [ ] Relationships are explicit with cardinality
+- [ ] Migration strategy specifies reversibility requirement
+- [ ] Seed data requirements defined
+- [ ] Backward compatibility approach documented
+
+**Save action**: Write `data_model.md`
+
+#### Phase 2c: Deployment Planning
+
+**Role**: DevOps / Platform engineer
+**Goal**: Produce deployment plan covering containerization, CI/CD, environment strategy, observability, and deployment procedures
+
+Use the `/deploy` skill's templates as structure for each artifact:
+
+1. Read architecture.md and restrictions.md for infrastructure constraints
+2. Research Docker best practices for the project's tech stack
+3. Define containerization plan: Dockerfile per component, docker-compose for dev and tests
+4. Define CI/CD pipeline: stages, quality gates, caching, parallelization
+5. Define environment strategy: dev, staging, production with secrets management
+6. Define observability: structured logging, metrics, tracing, alerting
+7. Define deployment procedures: strategy, health checks, rollback, checklist
+
+**Self-verification**:
+- [ ] Every component has a Docker specification
+- [ ] CI/CD pipeline covers lint, test, security, build, deploy
+- [ ] Environment strategy covers dev, staging, production
+- [ ] Observability covers logging, metrics, tracing, alerting
+- [ ] Deployment procedures include rollback and health checks
+
+**Save action**: Write all 5 files under `deployment/`:
+- `containerization.md`
+- `ci_cd_pipeline.md`
+- `environment_strategy.md`
+- `observability.md`
+- `deployment_procedures.md`
+
 ---

 ### Step 3: Component Decomposition
@@ -375,6 +436,20 @@ Before writing the final report, verify ALL of the following:
 - [ ] Deployment model is defined
 - [ ] Integration test findings are reflected in architecture decisions

+### Data Model
+- [ ] Every entity from architecture.md is defined
+- [ ] Relationships have explicit cardinality
+- [ ] Migration strategy with reversibility requirement
+- [ ] Seed data requirements defined
+- [ ] Backward compatibility approach documented
+
+### Deployment
+- [ ] Containerization plan covers all components
+- [ ] CI/CD pipeline includes lint, test, security, build, deploy stages
+- [ ] Environment strategy covers dev, staging, production
+- [ ] Observability covers logging, metrics, tracing, alerting
+- [ ] Deployment procedures include rollback and health checks
+
 ### Components
 - [ ] Every component follows SRP
 - [ ] No circular dependencies
@@ -441,8 +516,10 @@ Before writing the final report, verify ALL of the following:
 │                                                                │
 │ 1. Integration Tests  → integration_tests/ (5 files)           │
 │    [BLOCKING: user confirms test coverage]                     │
-│ 2. Solution Analysis  → architecture.md, system-flows.md       │
+│ 2a. Architecture      → architecture.md, system-flows.md       │
 │    [BLOCKING: user confirms architecture]                      │
+│ 2b. Data Model        → data_model.md                          │
+│ 2c. Deployment        → deployment/ (5 files)                  │
 │ 3. Component Decompose → components/[##]_[name]/description    │
 │    [BLOCKING: user confirms decomposition]                     │
 │ 4. Review & Risk      → risk_mitigations.md                    │