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.

This commit is contained in:
Oleksandr Bezdieniezhnykh
2026-03-19 12:10:11 +02:00
parent 5b1739186e
commit cfd09c79e1
17 changed files with 1314 additions and 313 deletions
+40 -37
View File
@@ -20,23 +20,20 @@
5. /implement — auto-orchestrates all tasks: batches by dependencies, launches parallel implementers, runs code review, loops until done
6. /implement-black-box-tests — E2E tests via Docker consumer app (after all tasks)
7. commit & push
6. commit & push
```
### SHIP (deploy and operate)
```
8. /implement-cicdvalidate/enhance CI/CD pipeline
9. /deploy — deployment strategy per environment
10. /observability — monitoring, logging, alerting plan
7. /deploy containerization, CI/CD, environment strategy, observability, deployment procedures (skill, 5-step workflow)
```
### EVOLVE (maintenance and improvement)
```
11. /refactor — structured refactoring (skill, 6-phase workflow)
8. /refactor — structured refactoring (skill, 6-phase workflow)
9. /retrospective — collect metrics, analyze trends, produce improvement report (skill)
```
## Implementation Flow
@@ -67,29 +64,25 @@ Multi-phase code review invoked after each implementation batch:
Produces structured findings with severity (Critical/High/Medium/Low) and verdict (PASS/FAIL/PASS_WITH_WARNINGS).
### `/implement-black-box-tests`
Reads `_docs/02_plans/integration_tests/` (produced by plan skill Step 1). Builds a separate Docker-based consumer app that exercises the system as a black box — no internal imports, no direct DB access. Runs E2E scenarios, produces a CSV test report.
Run after all tasks are done.
### `/implement-cicd`
Reviews existing CI/CD pipeline configuration, validates all stages work, optimizes performance (parallelization, caching), ensures quality gates are enforced (coverage, linting, security scanning).
Run after `/implement` or after all tasks.
### `/deploy`
Defines deployment strategy per environment: deployment procedures, rollback procedures, health checks, deployment checklist. Outputs `_docs/02_components/deployment_strategy.md`.
Comprehensive deployment skill (5-step workflow):
Run before first production release.
1. Containerization — Dockerfiles per component, docker-compose for dev and tests
2. CI/CD Pipeline — lint, test, security scan, build, deploy with quality gates
3. Environment Strategy — dev, staging, production with secrets management
4. Observability — structured logging, metrics, tracing, alerting, dashboards
5. Deployment Procedures — rollback, health checks, graceful shutdown
### `/observability`
Outputs to `_docs/02_plans/deployment/`. Run after `/implement` or before first production release.
Plans logging strategy, metrics collection, distributed tracing, alerting rules, and dashboards. Outputs `_docs/02_components/observability_plan.md`.
### `/retrospective`
Run before first production release.
Collects metrics from batch reports and code review findings, analyzes trends across implementation cycles, and produces improvement reports. Outputs to `_docs/05_metrics/`.
### `/rollback`
Reverts implementation to a specific batch checkpoint using git revert, resets Jira ticket statuses, and verifies rollback integrity with tests.
### Commit
@@ -106,6 +99,8 @@ After each confirmed batch, the `/implement` skill automatically commits and pus
| **code-review** | "code review", "review code" | 6-phase structured review with findings |
| **refactor** | "refactor", "refactoring", "improve code" | 6-phase structured refactoring workflow |
| **security** | "security audit", "OWASP" | OWASP-based security testing |
| **deploy** | "deploy", "CI/CD", "containerize", "observability" | Containerization, CI/CD, observability, deployment procedures |
| **retrospective** | "retrospective", "retro", "metrics review" | Collect metrics, analyze trends, produce improvement report |
## Project Folder Structure
@@ -134,6 +129,7 @@ _docs/
├── 02_plans/
│ ├── architecture.md
│ ├── system-flows.md
│ ├── data_model.md
│ ├── risk_mitigations.md
│ ├── components/
│ │ └── [##]_[name]/
@@ -146,6 +142,12 @@ _docs/
│ │ ├── functional_tests.md
│ │ ├── non_functional_tests.md
│ │ └── traceability_matrix.md
│ ├── deployment/
│ │ ├── containerization.md
│ │ ├── ci_cd_pipeline.md
│ │ ├── environment_strategy.md
│ │ ├── observability.md
│ │ └── deployment_procedures.md
│ ├── diagrams/
│ └── FINAL_report.md
├── 02_tasks/
@@ -158,15 +160,17 @@ _docs/
│ ├── batch_02_report.md
│ ├── ...
│ └── FINAL_implementation_report.md
── 04_refactoring/
├── baseline_metrics.md
├── discovery/
├── analysis/
├── test_specs/
├── coupling_analysis.md
├── execution_log.md
├── hardening/
└── FINAL_report.md
── 04_refactoring/
├── baseline_metrics.md
├── discovery/
├── analysis/
├── test_specs/
├── coupling_analysis.md
├── execution_log.md
├── hardening/
└── FINAL_report.md
└── 05_metrics/
└── retro_[date].md
```
## Implementation Tools
@@ -176,10 +180,9 @@ _docs/
| `implementer` | Subagent | Implements a single task from its spec. Launched by /implement. |
| `/implement` | Skill | Orchestrates all tasks: dependency batching, parallel agents, code review. |
| `/code-review` | Skill | Multi-phase code review with structured findings. |
| `/implement-black-box-tests` | Command | E2E tests via Docker consumer app. After all tasks. |
| `/implement-cicd` | Command | Validate and enhance CI/CD pipeline. |
| `/deploy` | Command | Plan deployment strategy per environment. |
| `/observability` | Command | Plan logging, metrics, tracing, alerting. |
| `/deploy` | Skill | Containerization, CI/CD, observability, deployment procedures. |
| `/retrospective` | Skill | Collect metrics, analyze trends, produce improvement reports. |
| `/rollback` | Command | Revert to a batch checkpoint with Jira status reset. |
## Automations (Planned)