mirror of
https://github.com/azaion/detections.git
synced 2026-04-22 09:06:31 +00:00
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:
+9
-9
@@ -11,7 +11,7 @@ If you want to run a specific skill directly (without the orchestrator), use the
|
||||
```
|
||||
/problem — interactive problem gathering → _docs/00_problem/
|
||||
/research — solution drafts → _docs/01_solution/
|
||||
/plan — architecture, components, tests → _docs/02_plans/
|
||||
/plan — architecture, components, tests → _docs/02_document/
|
||||
/decompose — atomic task specs → _docs/02_tasks/
|
||||
/implement — batched parallel implementation → _docs/03_implementation/
|
||||
/deploy — containerization, CI/CD, observability → _docs/04_deploy/
|
||||
@@ -97,9 +97,9 @@ OWASP-based security testing and audit.
|
||||
|
||||
Collects metrics from implementation batch reports, analyzes trends, produces improvement reports.
|
||||
|
||||
### rollback
|
||||
### document
|
||||
|
||||
Reverts implementation to a specific batch checkpoint using git revert, verifies integrity.
|
||||
Bottom-up codebase documentation. Analyzes existing code from modules through components to architecture, then retrospectively derives problem/restrictions/acceptance criteria. Alternative entry point for existing codebases — produces the same `_docs/` artifacts as problem + plan, but from code analysis instead of user interview.
|
||||
|
||||
## Developer TODO (Project Mode)
|
||||
|
||||
@@ -116,7 +116,7 @@ Reverts implementation to a specific batch checkpoint using git revert, verifies
|
||||
1. /research — solution drafts → _docs/01_solution/
|
||||
Run multiple times: Mode A → draft, Mode B → assess & revise
|
||||
|
||||
2. /plan — architecture, data model, deployment, components, risks, tests, Jira epics → _docs/02_plans/
|
||||
2. /plan — architecture, data model, deployment, components, risks, tests, Jira epics → _docs/02_document/
|
||||
|
||||
3. /decompose — atomic task specs + dependency table → _docs/02_tasks/
|
||||
|
||||
@@ -145,15 +145,15 @@ Or just use `/autopilot` to run steps 0-5 automatically.
|
||||
| **autopilot** | "autopilot", "auto", "start", "continue", "what's next" | Orchestrates full workflow |
|
||||
| **problem** | "problem", "define problem", "new project" | `_docs/00_problem/` |
|
||||
| **research** | "research", "investigate" | `_docs/01_solution/` |
|
||||
| **plan** | "plan", "decompose solution" | `_docs/02_plans/` |
|
||||
| **plan** | "plan", "decompose solution" | `_docs/02_document/` |
|
||||
| **decompose** | "decompose", "task decomposition" | `_docs/02_tasks/` |
|
||||
| **implement** | "implement", "start implementation" | `_docs/03_implementation/` |
|
||||
| **code-review** | "code review", "review code" | Verdict: PASS / FAIL / PASS_WITH_WARNINGS |
|
||||
| **refactor** | "refactor", "improve code" | `_docs/04_refactoring/` |
|
||||
| **security** | "security audit", "OWASP" | Security findings report |
|
||||
| **document** | "document", "document codebase", "reverse-engineer docs" | `_docs/02_document/` + `_docs/00_problem/` + `_docs/01_solution/` |
|
||||
| **deploy** | "deploy", "CI/CD", "observability" | `_docs/04_deploy/` |
|
||||
| **retrospective** | "retrospective", "retro" | `_docs/05_metrics/` |
|
||||
| **rollback** | "rollback", "revert batch" | `_docs/03_implementation/rollback_report.md` |
|
||||
|
||||
## Tools
|
||||
|
||||
@@ -169,7 +169,7 @@ _docs/
|
||||
├── 00_problem/ — problem definition, restrictions, AC, input data
|
||||
├── 00_research/ — intermediate research artifacts
|
||||
├── 01_solution/ — solution drafts, tech stack, security analysis
|
||||
├── 02_plans/
|
||||
├── 02_document/
|
||||
│ ├── architecture.md
|
||||
│ ├── system-flows.md
|
||||
│ ├── data_model.md
|
||||
@@ -181,7 +181,7 @@ _docs/
|
||||
│ ├── diagrams/
|
||||
│ └── FINAL_report.md
|
||||
├── 02_tasks/ — [JIRA-ID]_[name].md + _dependencies_table.md
|
||||
├── 03_implementation/ — batch reports, rollback report, FINAL report
|
||||
├── 03_implementation/ — batch reports, FINAL report
|
||||
├── 04_deploy/ — containerization, CI/CD, environments, observability, procedures, scripts
|
||||
├── 04_refactoring/ — baseline, discovery, analysis, execution, hardening
|
||||
└── 05_metrics/ — retro_[YYYY-MM-DD].md
|
||||
@@ -199,7 +199,7 @@ _docs/
|
||||
## Single Component Mode (Decompose)
|
||||
|
||||
```
|
||||
/decompose @_docs/02_plans/components/03_parser/description.md
|
||||
/decompose @_docs/02_document/components/03_parser/description.md
|
||||
```
|
||||
|
||||
Appends tasks for that component to `_docs/02_tasks/` without running bootstrap or cross-verification.
|
||||
|
||||
Reference in New Issue
Block a user