moicle 1.7.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -27
- package/assets/architecture/_shared/severity-levels.md +34 -0
- package/assets/architecture/_shared/stack-detection.md +34 -0
- package/assets/commands/marketing.md +7 -7
- package/assets/skills/docs/sync/SKILL.md +245 -0
- package/assets/skills/docs/write/SKILL.md +274 -0
- package/assets/skills/feature/api/SKILL.md +277 -0
- package/assets/skills/feature/deprecate/SKILL.md +276 -0
- package/assets/skills/feature/new/SKILL.md +273 -0
- package/assets/skills/feature/refactor/SKILL.md +269 -0
- package/assets/skills/fix/hotfix/SKILL.md +233 -0
- package/assets/skills/fix/incident/SKILL.md +360 -0
- package/assets/skills/fix/pr-comment/SKILL.md +186 -0
- package/assets/skills/fix/root-cause/SKILL.md +276 -0
- package/assets/skills/marketing/content/SKILL.md +269 -0
- package/assets/skills/marketing/logo/SKILL.md +252 -0
- package/assets/skills/marketing/seo-blog/SKILL.md +367 -0
- package/assets/skills/marketing/video/SKILL.md +258 -0
- package/assets/skills/research/onboarding/SKILL.md +225 -0
- package/assets/skills/research/spike/SKILL.md +228 -0
- package/assets/skills/research/web/SKILL.md +204 -0
- package/assets/skills/review/architect/SKILL.md +274 -0
- package/assets/skills/review/branch/SKILL.md +277 -0
- package/assets/skills/review/pr/SKILL.md +231 -0
- package/assets/skills/review/tdd/SKILL.md +245 -0
- package/dist/commands/list.d.ts.map +1 -1
- package/dist/commands/list.js +2 -2
- package/dist/commands/list.js.map +1 -1
- package/dist/utils/symlink.d.ts +7 -0
- package/dist/utils/symlink.d.ts.map +1 -1
- package/dist/utils/symlink.js +82 -0
- package/dist/utils/symlink.js.map +1 -1
- package/package.json +1 -1
- package/assets/skills/api-integration/SKILL.md +0 -883
- package/assets/skills/architect-review/SKILL.md +0 -393
- package/assets/skills/content-writer/SKILL.md +0 -721
- package/assets/skills/deep-debug/SKILL.md +0 -114
- package/assets/skills/deprecation/SKILL.md +0 -923
- package/assets/skills/documentation/SKILL.md +0 -1333
- package/assets/skills/fix-pr-comment/SKILL.md +0 -283
- package/assets/skills/hotfix/SKILL.md +0 -397
- package/assets/skills/incident-response/SKILL.md +0 -946
- package/assets/skills/logo-design/SKILL.md +0 -477
- package/assets/skills/new-feature/SKILL.md +0 -297
- package/assets/skills/onboarding/SKILL.md +0 -607
- package/assets/skills/pr-review/SKILL.md +0 -620
- package/assets/skills/refactor/SKILL.md +0 -338
- package/assets/skills/research/SKILL.md +0 -124
- package/assets/skills/review-changes/SKILL.md +0 -312
- package/assets/skills/spike/SKILL.md +0 -535
- package/assets/skills/sync-docs/SKILL.md +0 -575
- package/assets/skills/tdd/SKILL.md +0 -828
- package/assets/skills/video-content/SKILL.md +0 -651
package/README.md
CHANGED
|
@@ -14,10 +14,10 @@ A toolkit to bootstrap and accelerate project development with Claude Code throu
|
|
|
14
14
|
|
|
15
15
|
## Features
|
|
16
16
|
|
|
17
|
-
- **
|
|
18
|
-
- **
|
|
19
|
-
- **
|
|
20
|
-
- **
|
|
17
|
+
- **16 AI Agents** - 6 developer agents + 10 utility agents
|
|
18
|
+
- **4 Commands** - Wizards for bootstrap, brainstorm, documentation, and marketing
|
|
19
|
+
- **21 Skills** - Auto-triggered workflows for the full SDLC (feature, bug, review, release, ops, content)
|
|
20
|
+
- **8 Architecture References** - DDD + stack-specific patterns
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
## Current Support
|
|
@@ -114,29 +114,78 @@ moicle install --target codex --global
|
|
|
114
114
|
|
|
115
115
|
### Skills (21)
|
|
116
116
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
|
122
|
-
|
|
123
|
-
| `
|
|
124
|
-
| `
|
|
125
|
-
| `
|
|
126
|
-
| `
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
|
131
|
-
|
|
132
|
-
| `
|
|
133
|
-
| `
|
|
134
|
-
|
|
|
135
|
-
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
|
117
|
+
Skills are grouped into 6 namespaces. Type `/<group>:<tab>` in Claude Code to see all skills in a group.
|
|
118
|
+
|
|
119
|
+
**`/feature:*` — Build & Change**
|
|
120
|
+
|
|
121
|
+
| Skill | When to use |
|
|
122
|
+
|-------|-------------|
|
|
123
|
+
| `/feature:new` | Build a new feature end-to-end following DDD |
|
|
124
|
+
| `/feature:refactor` | Restructure existing module to DDD or improve internals |
|
|
125
|
+
| `/feature:api` | Add a new endpoint or integrate an external API |
|
|
126
|
+
| `/feature:deprecate` | Safely sunset a feature, API, or module |
|
|
127
|
+
|
|
128
|
+
**`/fix:*` — Bugs & Incidents**
|
|
129
|
+
|
|
130
|
+
| Skill | When to use |
|
|
131
|
+
|-------|-------------|
|
|
132
|
+
| `/fix:hotfix` | Fix a bug fast with a rollback plan |
|
|
133
|
+
| `/fix:root-cause` | Hard-to-trace bug that has been "fixed" multiple times |
|
|
134
|
+
| `/fix:incident` | Production outage / on-call workflow |
|
|
135
|
+
| `/fix:pr-comment` | Address review comments on an existing PR |
|
|
136
|
+
|
|
137
|
+
**`/review:*` — Review & Quality**
|
|
138
|
+
|
|
139
|
+
| Skill | When to use |
|
|
140
|
+
|-------|-------------|
|
|
141
|
+
| `/review:branch` | Self-review your branch BEFORE pushing / opening PR |
|
|
142
|
+
| `/review:pr` | Review someone else's open PR |
|
|
143
|
+
| `/review:architect` | DDD compliance check (called by `/feature:new` / `/feature:refactor`) |
|
|
144
|
+
| `/review:tdd` | Drive implementation with test-first discipline |
|
|
145
|
+
|
|
146
|
+
**`/research:*` — Explore & Learn**
|
|
147
|
+
|
|
148
|
+
| Skill | When to use |
|
|
149
|
+
|-------|-------------|
|
|
150
|
+
| `/research:web` | Search the web for solutions / best practices |
|
|
151
|
+
| `/research:spike` | Time-boxed prototype to learn / decide |
|
|
152
|
+
| `/research:onboarding` | Get up to speed on a new codebase |
|
|
153
|
+
|
|
154
|
+
**`/docs:*` — Project Documentation**
|
|
155
|
+
|
|
156
|
+
| Skill | When to use |
|
|
157
|
+
|-------|-------------|
|
|
158
|
+
| `/docs:write` | Author docs manually (README / API / ARCH / CONTRIB) |
|
|
159
|
+
| `/docs:sync` | Auto-generate structured docs from codebase with review loop |
|
|
160
|
+
|
|
161
|
+
**`/marketing:*` — Brand & Content** (wrapped by the `/marketing` command)
|
|
162
|
+
|
|
163
|
+
| Skill | When to use |
|
|
164
|
+
|-------|-------------|
|
|
165
|
+
| `/marketing:content` | Multi-post content strategy (pillars, calendar, channels) |
|
|
166
|
+
| `/marketing:seo-blog` | Write ONE evergreen blog post optimized for Search + AI tools |
|
|
167
|
+
| `/marketing:logo` | Logo + brand identity specification |
|
|
168
|
+
| `/marketing:video` | Video script, storyboard, production plan |
|
|
169
|
+
|
|
170
|
+
### Skill decision matrix
|
|
171
|
+
|
|
172
|
+
When more than one skill could fit, use this matrix:
|
|
173
|
+
|
|
174
|
+
| Situation | Use | Not |
|
|
175
|
+
|-----------|-----|-----|
|
|
176
|
+
| Bug just happened in prod, need fix in <1h | `/fix:hotfix` | `/fix:root-cause` (too slow) |
|
|
177
|
+
| Bug keeps coming back after "fixes" | `/fix:root-cause` | `/fix:hotfix` (will repeat) |
|
|
178
|
+
| About to push / open PR | `/review:branch` | `/review:pr` (that's for others') |
|
|
179
|
+
| Reviewing teammate's PR | `/review:pr` | `/review:branch` (that's for own branch) |
|
|
180
|
+
| Want to verify DDD compliance only | `/review:architect` | `/review:pr` (broader scope) |
|
|
181
|
+
| Don't know the right solution yet | `/research:web` | `/research:spike` (skip if you can decide from docs) |
|
|
182
|
+
| Need to validate an idea by building | `/research:spike` | `/feature:new` (commit only after spike) |
|
|
183
|
+
| Writing README / API docs by hand | `/docs:write` | `/docs:sync` (overkill for single file) |
|
|
184
|
+
| Generating full docs site from codebase | `/docs:sync` | `/docs:write` (manual is slower) |
|
|
185
|
+
|
|
186
|
+
### Backward compatibility
|
|
187
|
+
|
|
188
|
+
Old trigger phrases still work — they're kept in the skill `description` so Claude auto-invokes the right skill when the user says e.g. "deep debug", "hotfix", "review changes". The namespace `/group:action` is the new explicit invocation form.
|
|
140
189
|
|
|
141
190
|
## Architecture-First Approach
|
|
142
191
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Severity Levels — Canonical Reference
|
|
2
|
+
|
|
3
|
+
Single source of truth for severity classification across review, hotfix, and incident workflows.
|
|
4
|
+
|
|
5
|
+
## Code / Architecture Severity (review skills)
|
|
6
|
+
|
|
7
|
+
| Level | Meaning | Examples |
|
|
8
|
+
|-------|---------|----------|
|
|
9
|
+
| **CRITICAL** | Architecture broken; ship-blocker | Build fails, circular imports, domain imports framework, secrets in code |
|
|
10
|
+
| **HIGH** | DDD violation or correctness risk | Cross-domain import, business logic in wrong layer, no ports dir, N+1 query on main table, missing auth check |
|
|
11
|
+
| **MEDIUM** | Structure issue or test gap | Anemic entity, fat controller, missing events, missing test for new code path, missing JSON tags |
|
|
12
|
+
| **LOW** | Convention issue | File naming, redundant code, DTOs in wrong package, style nits |
|
|
13
|
+
|
|
14
|
+
**Rule:** all CRITICAL/HIGH must be fixed before merge. MEDIUM allowed with explicit waiver. LOW = nice to fix.
|
|
15
|
+
|
|
16
|
+
## Incident Severity (incident-response, hotfix)
|
|
17
|
+
|
|
18
|
+
| Level | Description | First response | Examples |
|
|
19
|
+
|-------|-------------|---------------|----------|
|
|
20
|
+
| **P1** | Critical — complete outage / data loss / security breach | <15 min | Site down, DB corrupted, secret leak, all logins broken |
|
|
21
|
+
| **P2** | High — major degradation, ≥50% users affected | <1 h | Login flow broken for one IdP, checkout fails, key endpoint 5xx |
|
|
22
|
+
| **P3** | Medium — partial degradation, <50% users | <4 h | One feature broken, perf regression on a non-critical path |
|
|
23
|
+
| **P4** | Low — minor issue, no significant impact | <24 h | UI glitch, typo in copy, deprecated warning |
|
|
24
|
+
|
|
25
|
+
**Ambiguous P2 vs P3?** If revenue impact, security risk, or data integrity in question → P2. Otherwise P3.
|
|
26
|
+
|
|
27
|
+
## Mapping between scales
|
|
28
|
+
|
|
29
|
+
| Code severity | If found in PR | If found in production |
|
|
30
|
+
|---------------|---------------|------------------------|
|
|
31
|
+
| CRITICAL | Block merge | P1 incident |
|
|
32
|
+
| HIGH | Request changes | P2 incident |
|
|
33
|
+
| MEDIUM | Comment | P3 incident |
|
|
34
|
+
| LOW | Comment / approve | P4 incident |
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Stack Detection — Canonical Reference
|
|
2
|
+
|
|
3
|
+
Used by skills that need to pick the right stack-specific architecture doc and conventions.
|
|
4
|
+
|
|
5
|
+
## Detection Rules
|
|
6
|
+
|
|
7
|
+
Check files in this order. **First match wins.**
|
|
8
|
+
|
|
9
|
+
| File / Pattern | Stack | Architecture doc |
|
|
10
|
+
|----------------|-------|------------------|
|
|
11
|
+
| `go.mod` | Go + Gin | `go-backend.md` |
|
|
12
|
+
| `package.json` contains `"@nestjs/core"` | NestJS | `nodejs-nestjs.md` |
|
|
13
|
+
| `package.json` + `vite.config.*` (no NestJS) | React + Vite | `react-frontend.md` |
|
|
14
|
+
| `package.json` + `remix.config.*` | Remix | `remix-fullstack.md` |
|
|
15
|
+
| `pubspec.yaml` | Flutter / Dart | `flutter-mobile.md` |
|
|
16
|
+
| `composer.json` | Laravel / PHP | `laravel-backend.md` |
|
|
17
|
+
| Workspace root has `pnpm-workspace.yaml` / `turbo.json` / `nx.json` | Monorepo | `monorepo.md` (plus the per-package stack above) |
|
|
18
|
+
|
|
19
|
+
## Architecture Files Location (priority order)
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
.claude/architecture/{name}.md # Project-specific — highest priority
|
|
23
|
+
~/.claude/architecture/{name}.md # Global
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Always load **two files**:
|
|
27
|
+
1. `ddd-architecture.md` — cross-stack DDD core rules
|
|
28
|
+
2. The stack-specific doc from the table above
|
|
29
|
+
|
|
30
|
+
## When stack is ambiguous
|
|
31
|
+
|
|
32
|
+
- Multi-stack monorepo: ask the user which package / app the task targets
|
|
33
|
+
- New project (no lock files yet): ask the user
|
|
34
|
+
- Multiple lock files (e.g., `go.mod` + `package.json` for a hybrid service): both stacks apply; usually backend = primary
|
|
@@ -30,13 +30,13 @@ Let the user choose which areas to focus on:
|
|
|
30
30
|
Which marketing areas do you want to plan?
|
|
31
31
|
|
|
32
32
|
1. Logo & Brand Identity — Design logo, colors, typography, brand guidelines
|
|
33
|
-
Triggers skill: logo
|
|
33
|
+
Triggers skill: /marketing:logo
|
|
34
34
|
|
|
35
35
|
2. Video Content Strategy — Plan video series, scripts, production, publishing
|
|
36
|
-
Triggers skill: video
|
|
36
|
+
Triggers skill: /marketing:video
|
|
37
37
|
|
|
38
38
|
3. Content Writing Strategy — Blog posts, social media, SEO, newsletter
|
|
39
|
-
Triggers skill: content
|
|
39
|
+
Triggers skill: /marketing:content
|
|
40
40
|
|
|
41
41
|
4. All of the Above — Complete marketing plan (Recommended)
|
|
42
42
|
|
|
@@ -55,19 +55,19 @@ MARKETING PLAN WORKFLOW
|
|
|
55
55
|
|
|
56
56
|
Phase 1: Brand Foundation
|
|
57
57
|
│
|
|
58
|
-
├── Execute: logo
|
|
58
|
+
├── Execute: /marketing:logo skill
|
|
59
59
|
│ └── Output: Brand guidelines, color palette, typography
|
|
60
60
|
│
|
|
61
61
|
▼
|
|
62
62
|
Phase 2: Content Strategy
|
|
63
63
|
│
|
|
64
|
-
├── Execute: content
|
|
64
|
+
├── Execute: /marketing:content skill
|
|
65
65
|
│ └── Output: Content pillars, blog plan, social media plan, newsletter
|
|
66
66
|
│
|
|
67
67
|
▼
|
|
68
68
|
Phase 3: Video Content
|
|
69
69
|
│
|
|
70
|
-
├── Execute: video
|
|
70
|
+
├── Execute: /marketing:video skill
|
|
71
71
|
│ └── Output: Video series, scripts, production specs, calendar
|
|
72
72
|
│
|
|
73
73
|
▼
|
|
@@ -85,7 +85,7 @@ Phase 5: Launch Plan
|
|
|
85
85
|
|
|
86
86
|
### Execution Notes:
|
|
87
87
|
- Run skills sequentially — brand identity informs content and video decisions
|
|
88
|
-
- Pass brand guidelines (colors, voice, tone) from logo
|
|
88
|
+
- Pass brand guidelines (colors, voice, tone) from /marketing:logo into /marketing:content and /marketing:video
|
|
89
89
|
- Ensure consistency across all outputs
|
|
90
90
|
|
|
91
91
|
## Step 4: Create Unified Calendar
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs-sync
|
|
3
|
+
description: Sync documentation workflow - reads codebase and docs folder to generate structured output docs with architecture, use cases, diagrams, and README index. Includes automated review loop. Use when user says "sync docs", "sync documentation", "generate docs", "update docs sync", "doc sync".
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Sync Docs Workflow
|
|
7
|
+
|
|
8
|
+
Generate a complete `docs/` site (business overview, architecture, use cases with sequence diagrams, README index) from the current codebase. Includes a 3-iteration auto-review loop.
|
|
9
|
+
|
|
10
|
+
## When to use this skill
|
|
11
|
+
|
|
12
|
+
- ✅ Re-generate the whole `docs/` site from current code
|
|
13
|
+
- ✅ Existing docs have drifted; want batch sync with review loop
|
|
14
|
+
- ✅ Project has no structured docs at all
|
|
15
|
+
- ❌ Authoring a single doc by hand (README / API.md only) → use `/docs:write`
|
|
16
|
+
- ❌ Understand the codebase, not document it → use `/research:onboarding`
|
|
17
|
+
- ❌ Adding doc for one endpoint → use `/feature:api` Phase 4
|
|
18
|
+
|
|
19
|
+
## Read Architecture First
|
|
20
|
+
|
|
21
|
+
Detect stack via `~/.claude/architecture/_shared/stack-detection.md`. Read `ddd-architecture.md` + stack doc.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Workflow
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
SCAN → CONFIRM mode → GENERATE → REVIEW loop (≤3x) → COMPLETE
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`CONFIRM` asks the user to pick **REFACTOR** (full restructure of `docs/`) or **UPDATE** (keep existing structure, refresh content).
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Phase 1: SCAN
|
|
36
|
+
|
|
37
|
+
**Goal:** map codebase + existing docs in one pass.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Existing docs
|
|
41
|
+
find . -name "*.md" -not -path "*/node_modules/*" -not -path "*/vendor/*" -not -path "*/.dart_tool/*" | sort
|
|
42
|
+
ls docs/ 2>/dev/null
|
|
43
|
+
|
|
44
|
+
# Code surface
|
|
45
|
+
tree -L 4 -I 'node_modules|vendor|dist|build|.dart_tool|.git'
|
|
46
|
+
|
|
47
|
+
# Entry points / use cases (per stack)
|
|
48
|
+
# Go: grep -r "func.*Handler" internal/
|
|
49
|
+
# NestJS: grep -r "@Controller\|@Get\|@Post" src/
|
|
50
|
+
# Laravel: cat routes/web.php routes/api.php
|
|
51
|
+
# Remix: ls app/routes/
|
|
52
|
+
# Flutter: grep -r "MaterialPageRoute\|GoRoute" lib/
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Extract
|
|
56
|
+
- Stack + framework
|
|
57
|
+
- All domains / modules
|
|
58
|
+
- All user-facing flows (endpoints / screens / commands)
|
|
59
|
+
- Existing docs structure (if any)
|
|
60
|
+
|
|
61
|
+
### Gate
|
|
62
|
+
- [ ] Stack identified
|
|
63
|
+
- [ ] All domains listed
|
|
64
|
+
- [ ] All use cases listed (count + brief name)
|
|
65
|
+
- [ ] Existing docs inventoried
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Phase 1.5: CONFIRM
|
|
70
|
+
|
|
71
|
+
Ask the user **explicitly** which mode:
|
|
72
|
+
|
|
73
|
+
| Mode | When to use | Effect |
|
|
74
|
+
|------|-------------|--------|
|
|
75
|
+
| **REFACTOR** | Existing docs are messy / partial / wrong structure | Restructure `docs/` from scratch, may delete old files |
|
|
76
|
+
| **UPDATE** | Existing structure is fine, content is stale | Keep file paths + headings, refresh content + add missing sections |
|
|
77
|
+
|
|
78
|
+
If the user is unsure: default to **UPDATE** (less destructive).
|
|
79
|
+
|
|
80
|
+
### Gate
|
|
81
|
+
- [ ] User confirmed mode
|
|
82
|
+
- [ ] If REFACTOR: explicit OK to remove old files
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Phase 2: GENERATE
|
|
87
|
+
|
|
88
|
+
**Goal:** produce the target `docs/` tree.
|
|
89
|
+
|
|
90
|
+
### Target structure (REFACTOR mode)
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
docs/
|
|
94
|
+
├── README.md # Index linking to everything below
|
|
95
|
+
├── business.md # WHAT the system does, for non-engineers
|
|
96
|
+
├── architecture.md # HOW it's structured (layers + domains + tech)
|
|
97
|
+
├── use-cases/
|
|
98
|
+
│ ├── README.md # Index of use cases
|
|
99
|
+
│ ├── <use-case-1>.md # One file per user-facing flow, with sequence diagram
|
|
100
|
+
│ └── ...
|
|
101
|
+
├── api.md # If service has external API
|
|
102
|
+
└── runbook.md # How to run / deploy / debug
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### File rules
|
|
106
|
+
|
|
107
|
+
**`docs/README.md`** — index only (≤30 lines).
|
|
108
|
+
- One-line description, link to each sub-doc, last-updated timestamp.
|
|
109
|
+
|
|
110
|
+
**`docs/business.md`** — for non-engineers.
|
|
111
|
+
- NO API endpoints, NO code blocks, NO file paths
|
|
112
|
+
- Cover: what problem this solves, who uses it, key user journeys (named like a PRD), success metrics
|
|
113
|
+
- Plain language, no jargon
|
|
114
|
+
|
|
115
|
+
**`docs/architecture.md`** — for engineers.
|
|
116
|
+
- Layer diagram (mermaid)
|
|
117
|
+
- Domain list with 1-line responsibility
|
|
118
|
+
- Cross-domain communication pattern
|
|
119
|
+
- Tech decisions (DB, queue, cache, auth — with rationale)
|
|
120
|
+
- Link to `~/.claude/architecture/<stack>.md` for layer rules
|
|
121
|
+
|
|
122
|
+
**`docs/use-cases/<name>.md`** — one per flow.
|
|
123
|
+
- Trigger (who, what action)
|
|
124
|
+
- Preconditions
|
|
125
|
+
- Sequence diagram (mermaid `sequenceDiagram`) showing actor → handler → usecase → infra → response
|
|
126
|
+
- Postconditions / side effects (events raised, notifications sent)
|
|
127
|
+
- Errors (each with HTTP code + meaning)
|
|
128
|
+
|
|
129
|
+
**`docs/api.md`** — only if external API exists.
|
|
130
|
+
- Auth, base URL, error format, pagination — then endpoint table
|
|
131
|
+
- For deep API ref, link to OpenAPI spec
|
|
132
|
+
|
|
133
|
+
**`docs/runbook.md`** — for ops / on-call.
|
|
134
|
+
- Local dev (≤5 commands)
|
|
135
|
+
- Deploy steps
|
|
136
|
+
- Common failures + how to recover
|
|
137
|
+
- Monitoring dashboards + log queries
|
|
138
|
+
|
|
139
|
+
### Mermaid rules
|
|
140
|
+
|
|
141
|
+
- Sequence diagrams for use cases
|
|
142
|
+
- Class diagrams only when ER is non-obvious
|
|
143
|
+
- Validate syntax: `mermaid-cli` if available, otherwise eyeball test
|
|
144
|
+
- ≤7 actors per sequence (split if more)
|
|
145
|
+
|
|
146
|
+
### Gate
|
|
147
|
+
- [ ] All target files written
|
|
148
|
+
- [ ] business.md has zero code / endpoints
|
|
149
|
+
- [ ] Every use case has a sequence diagram
|
|
150
|
+
- [ ] README.md links to every file
|
|
151
|
+
- [ ] All file paths in docs resolve (no broken references)
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## Phase 3: REVIEW LOOP (≤3 iterations)
|
|
156
|
+
|
|
157
|
+
**Goal:** auto-check + fix until docs pass.
|
|
158
|
+
|
|
159
|
+
For each iteration:
|
|
160
|
+
|
|
161
|
+
### 3.1 Structure
|
|
162
|
+
- [ ] All target files exist
|
|
163
|
+
- [ ] README.md links resolve
|
|
164
|
+
- [ ] No duplicate content across files
|
|
165
|
+
|
|
166
|
+
### 3.2 Business
|
|
167
|
+
- [ ] business.md uses plain language (no `API`, `JSON`, `class`, file paths)
|
|
168
|
+
- [ ] business.md covers all top-level user journeys
|
|
169
|
+
|
|
170
|
+
### 3.3 Architecture
|
|
171
|
+
- [ ] Layer diagram matches actual code structure
|
|
172
|
+
- [ ] Every code domain has a row in domain table
|
|
173
|
+
|
|
174
|
+
### 3.4 Use cases
|
|
175
|
+
- [ ] One file per identified use case (Phase 1)
|
|
176
|
+
- [ ] Each has trigger / preconditions / sequence / postconditions / errors
|
|
177
|
+
- [ ] Sequence diagrams render
|
|
178
|
+
|
|
179
|
+
### 3.5 Consistency
|
|
180
|
+
- [ ] Same terminology everywhere (e.g., "domain" vs "module")
|
|
181
|
+
- [ ] No file paths referenced that don't exist
|
|
182
|
+
- [ ] No endpoints referenced that don't exist in code
|
|
183
|
+
|
|
184
|
+
### Loop
|
|
185
|
+
- If any check fails → fix that section, restart the relevant subset of checks
|
|
186
|
+
- Max 3 iterations; if still failing → report what's blocking + ask user
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## Phase 4: COMPLETE
|
|
191
|
+
|
|
192
|
+
```markdown
|
|
193
|
+
## Docs Sync Complete
|
|
194
|
+
|
|
195
|
+
### Mode: {REFACTOR / UPDATE}
|
|
196
|
+
|
|
197
|
+
### Files
|
|
198
|
+
- Created: {N}
|
|
199
|
+
- Updated: {N}
|
|
200
|
+
- Deleted: {N — REFACTOR mode only}
|
|
201
|
+
|
|
202
|
+
### Coverage
|
|
203
|
+
- Domains documented: {N/N}
|
|
204
|
+
- Use cases documented: {N/N}
|
|
205
|
+
- Diagrams: {N}
|
|
206
|
+
|
|
207
|
+
### Review iterations: {1/2/3}
|
|
208
|
+
|
|
209
|
+
### Next steps for the team
|
|
210
|
+
- Review `docs/business.md` with product
|
|
211
|
+
- Validate `docs/use-cases/*.md` flows with team leads
|
|
212
|
+
- Set up doc lint in CI (broken-link checker)
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Hard Rules
|
|
218
|
+
|
|
219
|
+
- **business.md is for humans** — strip jargon, no code, no file paths
|
|
220
|
+
- **architecture.md links to canonical rules**, doesn't duplicate them
|
|
221
|
+
- **One use case per file** — easier to update, easier to review
|
|
222
|
+
- **Mermaid only if it renders** — broken diagrams worse than no diagrams
|
|
223
|
+
- **REFACTOR mode requires explicit user OK** — never delete docs without confirmation
|
|
224
|
+
- **Max 3 review iterations** — beyond that, the prompt or scope is the problem, not the docs
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
## Related Skills
|
|
229
|
+
|
|
230
|
+
| When | Use |
|
|
231
|
+
|------|-----|
|
|
232
|
+
| Author single doc by hand | `/docs:write` |
|
|
233
|
+
| Onboard self / new dev | `/research:onboarding` |
|
|
234
|
+
| Doc only one new endpoint | `/feature:api` Phase 4 |
|
|
235
|
+
| Architecture itself needs review | `/review:architect` |
|
|
236
|
+
|
|
237
|
+
## Recommended Agents
|
|
238
|
+
|
|
239
|
+
| Phase | Agent | Purpose |
|
|
240
|
+
|-------|-------|---------|
|
|
241
|
+
| SCAN | `@clean-architect` | Identify domains + patterns |
|
|
242
|
+
| GENERATE | `@docs-writer` | Write all doc files |
|
|
243
|
+
| GENERATE | `@api-designer` | API reference accuracy |
|
|
244
|
+
| GENERATE | `@db-designer` | Data model accuracy |
|
|
245
|
+
| REVIEW | `@code-reviewer` | Verify code refs resolve |
|