Refactor documentation structure by renaming 'plans' directory to 'document' across various skills and templates. Update references in README and skill files to reflect the new directory structure for improved clarity and organization.

This commit is contained in:
Oleksandr Bezdieniezhnykh
2026-03-21 14:25:05 +02:00
parent 7556f3b012
commit 2a17590248
22 changed files with 676 additions and 206 deletions
+8 -8
View File
@@ -3,7 +3,7 @@ name: plan
description: |
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.
Uses _docs/ + _docs/02_document/ structure.
Trigger phrases:
- "plan", "decompose solution", "architecture planning"
- "break down the solution", "create planning documents"
@@ -31,7 +31,7 @@ Fixed paths — no mode detection needed:
- PROBLEM_FILE: `_docs/00_problem/problem.md`
- SOLUTION_FILE: `_docs/01_solution/solution.md`
- PLANS_DIR: `_docs/02_plans/`
- DOCUMENT_DIR: `_docs/02_document/`
Announce the resolved paths to the user before proceeding.
@@ -72,17 +72,17 @@ Only runs after the Data Gate passes:
**Prereq 3: Workspace Setup**
1. Create PLANS_DIR if it does not exist
2. If PLANS_DIR already contains artifacts, ask user: **resume from last checkpoint or start fresh?**
1. Create DOCUMENT_DIR if it does not exist
2. If DOCUMENT_DIR already contains artifacts, ask user: **resume from last checkpoint or start fresh?**
## Artifact Management
### Directory Structure
All artifacts are written directly under PLANS_DIR:
All artifacts are written directly under DOCUMENT_DIR:
```
PLANS_DIR/
DOCUMENT_DIR/
├── integration_tests/
│ ├── environment.md
│ ├── test_data.md
@@ -150,7 +150,7 @@ PLANS_DIR/
### Resumability
If PLANS_DIR already contains artifacts:
If DOCUMENT_DIR already contains artifacts:
1. List existing files and match them to the save timing table above
2. Identify the last completed step based on which artifacts exist
@@ -534,7 +534,7 @@ Before writing the final report, verify ALL of the following:
│ PREREQ 2: Finalize solution draft │
│ → rename highest solution_draft##.md to solution.md │
│ PREREQ 3: Workspace setup │
│ → create PLANS_DIR/ if needed │
│ → create DOCUMENT_DIR/ if needed │
│ │
│ 1. Integration Tests → integration_tests/ (5 files) │
│ [BLOCKING: user confirms test coverage] │
@@ -1,6 +1,6 @@
# Architecture Document Template
Use this template for the architecture document. Save as `_docs/02_plans/architecture.md`.
Use this template for the architecture document. Save as `_docs/02_document/architecture.md`.
---
+3 -3
View File
@@ -73,9 +73,9 @@ Link to architecture.md and relevant component spec.]
### Design & Architecture
- Architecture doc: `_docs/02_plans/architecture.md`
- Component spec: `_docs/02_plans/components/[##]_[name]/description.md`
- System flows: `_docs/02_plans/system-flows.md`
- Architecture doc: `_docs/02_document/architecture.md`
- Component spec: `_docs/02_document/components/[##]_[name]/description.md`
- System flows: `_docs/02_document/system-flows.md`
### Definition of Done
@@ -1,6 +1,6 @@
# Final Planning Report Template
Use this template after completing all 5 steps and the quality checklist. Save as `_docs/02_plans/FINAL_report.md`.
Use this template after completing all 5 steps and the quality checklist. Save as `_docs/02_document/FINAL_report.md`.
---
@@ -1,6 +1,6 @@
# E2E Test Environment Template
Save as `PLANS_DIR/integration_tests/environment.md`.
Save as `DOCUMENT_DIR/integration_tests/environment.md`.
---
@@ -1,6 +1,6 @@
# E2E Functional Tests Template
Save as `PLANS_DIR/integration_tests/functional_tests.md`.
Save as `DOCUMENT_DIR/integration_tests/functional_tests.md`.
---
@@ -1,6 +1,6 @@
# E2E Non-Functional Tests Template
Save as `PLANS_DIR/integration_tests/non_functional_tests.md`.
Save as `DOCUMENT_DIR/integration_tests/non_functional_tests.md`.
---
@@ -1,6 +1,6 @@
# E2E Test Data Template
Save as `PLANS_DIR/integration_tests/test_data.md`.
Save as `DOCUMENT_DIR/integration_tests/test_data.md`.
---
@@ -1,6 +1,6 @@
# E2E Traceability Matrix Template
Save as `PLANS_DIR/integration_tests/traceability_matrix.md`.
Save as `DOCUMENT_DIR/integration_tests/traceability_matrix.md`.
---
@@ -1,6 +1,6 @@
# Risk Register Template
Use this template for risk assessment. Save as `_docs/02_plans/risk_mitigations.md`.
Use this template for risk assessment. Save as `_docs/02_document/risk_mitigations.md`.
Subsequent iterations: `risk_mitigations_02.md`, `risk_mitigations_03.md`, etc.
---
@@ -1,7 +1,7 @@
# System Flows Template
Use this template for the system flows document. Save as `_docs/02_plans/system-flows.md`.
Individual flow diagrams go in `_docs/02_plans/diagrams/flows/flow_[name].md`.
Use this template for the system flows document. Save as `_docs/02_document/system-flows.md`.
Individual flow diagrams go in `_docs/02_document/diagrams/flows/flow_[name].md`.
---