@damenor/agent-docs 0.1.0 → 0.1.2
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 +141 -71
- package/dist/index.js +259 -13
- package/package.json +11 -11
- package/templates/base/README.md +64 -69
- package/templates/base/docs/CONTEXT.md +111 -111
- package/templates/modules/agents/.agents/skills/doc-maintain/SKILL.md +193 -193
- package/templates/modules/agents/.agents/skills/doc-review/SKILL.md +223 -223
- package/templates/modules/agents/.agents/skills/doc-scaffold/SKILL.md +155 -155
- package/templates/modules/agents/.agents/skills/doc-write/SKILL.md +197 -197
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: doc-maintain
|
|
3
3
|
description: >
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
post-
|
|
8
|
-
TRIGGER:
|
|
9
|
-
"post-feature", "post-release", "post-incident",
|
|
10
|
-
|
|
4
|
+
Keeps documentation synchronized with code changes.
|
|
5
|
+
Runs AFTER each task that modifies code, using the trigger
|
|
6
|
+
table to determine which documentation to update. Follows the
|
|
7
|
+
post-task protocol from AGENTS.md.
|
|
8
|
+
TRIGGER: When the user says "sync docs", "update docs post-change",
|
|
9
|
+
"post-feature", "post-release", "post-incident", or automatically after
|
|
10
|
+
any task that changes code.
|
|
11
11
|
license: Apache-2.0
|
|
12
12
|
metadata:
|
|
13
13
|
author: damenordev
|
|
@@ -16,120 +16,120 @@ metadata:
|
|
|
16
16
|
|
|
17
17
|
# doc-maintain
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## When to Use
|
|
20
20
|
|
|
21
|
-
- **Post-feature**:
|
|
22
|
-
- **Post-release**:
|
|
23
|
-
- **Post-incident**:
|
|
24
|
-
- **Post-refactor**:
|
|
25
|
-
- **Post-hire**:
|
|
26
|
-
- **Post-design-change**:
|
|
27
|
-
- **Post-API-change**:
|
|
28
|
-
- **Post-config-change**:
|
|
21
|
+
- **Post-feature**: After implementing a new feature
|
|
22
|
+
- **Post-release**: After making a release to production
|
|
23
|
+
- **Post-incident**: After resolving a production incident
|
|
24
|
+
- **Post-refactor**: After refactoring code
|
|
25
|
+
- **Post-hire**: When a new dev reviews the documentation
|
|
26
|
+
- **Post-design-change**: After changes to styles/UI
|
|
27
|
+
- **Post-API-change**: After adding/modifying/removing endpoints
|
|
28
|
+
- **Post-config-change**: After changing configuration
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Critical Patterns
|
|
31
31
|
|
|
32
|
-
###
|
|
32
|
+
### RULE #1: This skill runs AFTER every task that changes code
|
|
33
33
|
|
|
34
34
|
```
|
|
35
|
-
|
|
35
|
+
Code changed → doc-maintain runs
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
It is not optional. It is not "when there's time". It is part of the Definition of Done.
|
|
39
39
|
|
|
40
|
-
###
|
|
40
|
+
### RULE #2: Verify what changed and update corresponding docs
|
|
41
41
|
|
|
42
42
|
```
|
|
43
|
-
1.
|
|
44
|
-
2.
|
|
45
|
-
3.
|
|
46
|
-
4.
|
|
43
|
+
1. Identify which files changed (git diff, change list)
|
|
44
|
+
2. Map changes to affected documentation (see trigger table)
|
|
45
|
+
3. Update each affected doc file
|
|
46
|
+
4. Verify consistency
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
###
|
|
49
|
+
### RULE #3: NEVER skip doc updates
|
|
50
50
|
|
|
51
51
|
```
|
|
52
|
-
|
|
52
|
+
Code changes = Documentation changes
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
If there's no time to update docs, there's no time to make the code change.
|
|
56
56
|
|
|
57
|
-
###
|
|
57
|
+
### RULE #4: Follow the post-task protocol from AGENTS.md
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
Execute the **post-task tree** defined in `AGENTS.md` § AFTER each task. That tree is the source of truth for which documentation to update based on what changed.
|
|
60
60
|
|
|
61
|
-
###
|
|
61
|
+
### RULE #5: If unsure what to update, run doc-review first
|
|
62
62
|
|
|
63
63
|
```
|
|
64
|
-
|
|
65
|
-
→
|
|
66
|
-
→
|
|
67
|
-
→
|
|
64
|
+
Not clear which docs are affected?
|
|
65
|
+
→ Run doc-review skill
|
|
66
|
+
→ Identify gaps
|
|
67
|
+
→ Update based on the report
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
##
|
|
70
|
+
## Trigger and Action Table
|
|
71
71
|
|
|
72
72
|
### Post-feature
|
|
73
73
|
|
|
74
|
-
**
|
|
74
|
+
**What to detect**: A new feature was added (new module, new functionality, new endpoint)
|
|
75
75
|
|
|
76
|
-
**Docs
|
|
76
|
+
**Docs to update**:
|
|
77
77
|
|
|
78
|
-
|
|
|
79
|
-
|
|
80
|
-
| `docs/CONTEXT.md` |
|
|
81
|
-
| `docs/README.md` |
|
|
82
|
-
| `docs/adr/` |
|
|
83
|
-
| `how-to/` |
|
|
84
|
-
| `reference/` |
|
|
85
|
-
| `tutorials/` |
|
|
86
|
-
| `CHANGELOG.md` |
|
|
78
|
+
| Document | When | Priority | Skill |
|
|
79
|
+
|----------|------|----------|-------|
|
|
80
|
+
| `docs/CONTEXT.md` | If there are new terms | Critical | doc-write |
|
|
81
|
+
| `docs/README.md` | If doc files were created/removed | Critical | doc-write |
|
|
82
|
+
| `docs/adr/` | If an architectural decision was made | High | doc-write |
|
|
83
|
+
| `how-to/` | If there is a repeatable problem the feature solves | Medium | doc-write |
|
|
84
|
+
| `reference/` | If endpoints/functions/props were added | High | doc-write |
|
|
85
|
+
| `tutorials/` | If the feature changes onboarding | Low | doc-write |
|
|
86
|
+
| `CHANGELOG.md` | If the feature will be in a release | High | doc-write |
|
|
87
87
|
|
|
88
88
|
### Post-release
|
|
89
89
|
|
|
90
|
-
**
|
|
90
|
+
**What to detect**: A deploy to production was made, a version tag was created
|
|
91
91
|
|
|
92
|
-
**Docs
|
|
92
|
+
**Docs to update**:
|
|
93
93
|
|
|
94
|
-
|
|
|
95
|
-
|
|
96
|
-
| `CHANGELOG.md` |
|
|
97
|
-
| `docs/guides/deployment.md` |
|
|
98
|
-
| `docs/README.md` |
|
|
99
|
-
| `README.md` |
|
|
94
|
+
| Document | When | Priority | Skill |
|
|
95
|
+
|----------|------|----------|-------|
|
|
96
|
+
| `CHANGELOG.md` | Always | Critical | doc-write |
|
|
97
|
+
| `docs/guides/deployment.md` | If the deploy process changed | High | doc-write |
|
|
98
|
+
| `docs/README.md` | If the doc structure changed | Medium | doc-write |
|
|
99
|
+
| `README.md` | If there are user-visible changes | High | doc-write |
|
|
100
100
|
|
|
101
|
-
**
|
|
101
|
+
**CHANGELOG entry**:
|
|
102
102
|
```markdown
|
|
103
103
|
## [X.Y.Z] - YYYY-MM-DD
|
|
104
104
|
|
|
105
105
|
### Added
|
|
106
|
-
-
|
|
106
|
+
- Description of new feature
|
|
107
107
|
|
|
108
108
|
### Changed
|
|
109
|
-
-
|
|
109
|
+
- Description of change
|
|
110
110
|
|
|
111
111
|
### Fixed
|
|
112
|
-
-
|
|
112
|
+
- Description of fix
|
|
113
113
|
|
|
114
114
|
### Breaking
|
|
115
|
-
- ⚠️
|
|
115
|
+
- ⚠️ Description of breaking change
|
|
116
116
|
```
|
|
117
117
|
|
|
118
118
|
### Post-incident
|
|
119
119
|
|
|
120
|
-
**
|
|
120
|
+
**What to detect**: A production incident was resolved (outage, critical bug, data loss)
|
|
121
121
|
|
|
122
|
-
**Docs
|
|
122
|
+
**Docs to update**:
|
|
123
123
|
|
|
124
|
-
|
|
|
125
|
-
|
|
126
|
-
| `operations/post-mortems/YYYY-MM-DD-
|
|
127
|
-
| `operations/runbooks/` |
|
|
128
|
-
| `docs/CONTEXT.md` |
|
|
129
|
-
| `reference/configuration.md` |
|
|
130
|
-
| `how-to/troubleshooting.md` |
|
|
124
|
+
| Document | When | Priority | Skill |
|
|
125
|
+
|----------|------|----------|-------|
|
|
126
|
+
| `operations/post-mortems/YYYY-MM-DD-title.md` | Always | Critical | doc-write |
|
|
127
|
+
| `operations/runbooks/` | If there are resolution steps to repeat | High | doc-write |
|
|
128
|
+
| `docs/CONTEXT.md` | If domain terms were discovered | Medium | doc-write |
|
|
129
|
+
| `reference/configuration.md` | If configs were changed during the incident | High | doc-write |
|
|
130
|
+
| `how-to/troubleshooting.md` | If the fix is applicable in the future | High | doc-write |
|
|
131
131
|
|
|
132
|
-
**
|
|
132
|
+
**Post-mortem format**:
|
|
133
133
|
```markdown
|
|
134
134
|
---
|
|
135
135
|
created: "YYYY-MM-DD"
|
|
@@ -138,208 +138,208 @@ type: explanation
|
|
|
138
138
|
tags: [post-mortem, incident, sev-N]
|
|
139
139
|
---
|
|
140
140
|
|
|
141
|
-
# Post-mortem: [
|
|
141
|
+
# Post-mortem: [Incident title]
|
|
142
142
|
|
|
143
|
-
**
|
|
144
|
-
**
|
|
145
|
-
**
|
|
146
|
-
**
|
|
143
|
+
**Date**: YYYY-MM-DD
|
|
144
|
+
**Severity**: SEV-N
|
|
145
|
+
**Duration**: X hours/minutes
|
|
146
|
+
**Impact**: Description of user impact
|
|
147
147
|
|
|
148
|
-
##
|
|
149
|
-
- HH:MM —
|
|
150
|
-
- HH:MM —
|
|
151
|
-
- HH:MM —
|
|
152
|
-
- HH:MM —
|
|
148
|
+
## Timeline
|
|
149
|
+
- HH:MM — Detection
|
|
150
|
+
- HH:MM — Diagnosis
|
|
151
|
+
- HH:MM — Mitigation
|
|
152
|
+
- HH:MM — Resolution
|
|
153
153
|
|
|
154
|
-
##
|
|
155
|
-
[
|
|
154
|
+
## Root cause
|
|
155
|
+
[Description]
|
|
156
156
|
|
|
157
|
-
##
|
|
158
|
-
- [ ] [
|
|
159
|
-
- [ ] [
|
|
157
|
+
## Preventive actions
|
|
158
|
+
- [ ] [Action 1] — Responsible — Deadline
|
|
159
|
+
- [ ] [Action 2] — Responsible — Deadline
|
|
160
160
|
|
|
161
|
-
##
|
|
162
|
-
[
|
|
161
|
+
## Lessons learned
|
|
162
|
+
[What we learned]
|
|
163
163
|
```
|
|
164
164
|
|
|
165
165
|
### Post-refactor
|
|
166
166
|
|
|
167
|
-
**
|
|
167
|
+
**What to detect**: Code was refactored (renamed, moved, changed patterns)
|
|
168
168
|
|
|
169
|
-
**Docs
|
|
169
|
+
**Docs to update**:
|
|
170
170
|
|
|
171
|
-
|
|
|
172
|
-
|
|
173
|
-
| `docs/adr/` |
|
|
174
|
-
| `docs/explanation/architecture.md` |
|
|
175
|
-
| `docs/CONTEXT.md` |
|
|
176
|
-
| `docs/README.md` |
|
|
177
|
-
| ADRs
|
|
171
|
+
| Document | When | Priority | Skill |
|
|
172
|
+
|----------|------|----------|-------|
|
|
173
|
+
| `docs/adr/` | If the refactor implies a pattern change | High | doc-write |
|
|
174
|
+
| `docs/explanation/architecture.md` | If the architecture changed | High | doc-write |
|
|
175
|
+
| `docs/CONTEXT.md` | If names/terms changed | Critical | doc-write |
|
|
176
|
+
| `docs/README.md` | If files were moved | Medium | doc-write |
|
|
177
|
+
| Existing ADRs | Verify they are still valid | High | doc-write |
|
|
178
178
|
|
|
179
179
|
### Post-hire
|
|
180
180
|
|
|
181
|
-
**
|
|
181
|
+
**What to detect**: A new dev joined the team and reviews the documentation
|
|
182
182
|
|
|
183
|
-
**Docs
|
|
183
|
+
**Docs to update**:
|
|
184
184
|
|
|
185
|
-
|
|
|
186
|
-
|
|
187
|
-
| `tutorials/quick-start.md` |
|
|
188
|
-
| `docs/CONTEXT.md` |
|
|
189
|
-
|
|
|
185
|
+
| Document | When | Priority | Skill |
|
|
186
|
+
|----------|------|----------|-------|
|
|
187
|
+
| `tutorials/quick-start.md` | If the new dev couldn't follow the tutorial | Critical | doc-write |
|
|
188
|
+
| `docs/CONTEXT.md` | If the new dev found confusing terms | High | doc-write |
|
|
189
|
+
| Any doc | If the new dev found incorrect info | High | doc-write |
|
|
190
190
|
|
|
191
191
|
### Post-design-change
|
|
192
192
|
|
|
193
|
-
**
|
|
193
|
+
**What to detect**: Styles, design tokens, or UI components were changed
|
|
194
194
|
|
|
195
|
-
**Docs
|
|
195
|
+
**Docs to update**:
|
|
196
196
|
|
|
197
|
-
|
|
|
198
|
-
|
|
199
|
-
| `DESIGN.md` |
|
|
200
|
-
| `docs/CONTEXT.md` |
|
|
197
|
+
| Document | When | Priority | Skill |
|
|
198
|
+
|----------|------|----------|-------|
|
|
199
|
+
| `DESIGN.md` | Always | Critical | doc-design |
|
|
200
|
+
| `docs/CONTEXT.md` | If there are new design terms | Medium | doc-write |
|
|
201
201
|
|
|
202
|
-
**
|
|
202
|
+
**Use skill `doc-design`** to re-extract tokens and update DESIGN.md.
|
|
203
203
|
|
|
204
204
|
### Post-API-change
|
|
205
205
|
|
|
206
|
-
**
|
|
206
|
+
**What to detect**: Endpoints were added, modified, or removed
|
|
207
207
|
|
|
208
|
-
**Docs
|
|
208
|
+
**Docs to update**:
|
|
209
209
|
|
|
210
|
-
|
|
|
211
|
-
|
|
212
|
-
| `reference/api.md` |
|
|
213
|
-
| `CHANGELOG.md` |
|
|
214
|
-
| `docs/adr/` |
|
|
215
|
-
| `how-to/` |
|
|
210
|
+
| Document | When | Priority | Skill |
|
|
211
|
+
|----------|------|----------|-------|
|
|
212
|
+
| `reference/api.md` | Always | Critical | doc-write |
|
|
213
|
+
| `CHANGELOG.md` | If there are breaking changes | Critical | doc-write |
|
|
214
|
+
| `docs/adr/` | If the API structure changed | High | doc-write |
|
|
215
|
+
| `how-to/` | If there are new usage flows | Medium | doc-write |
|
|
216
216
|
|
|
217
217
|
### Post-config-change
|
|
218
218
|
|
|
219
|
-
**
|
|
219
|
+
**What to detect**: Environment variables, configurations, or infrastructure were changed
|
|
220
220
|
|
|
221
|
-
**Docs
|
|
221
|
+
**Docs to update**:
|
|
222
222
|
|
|
223
|
-
|
|
|
224
|
-
|
|
225
|
-
| `reference/configuration.md` |
|
|
226
|
-
| `docs/guides/deployment.md` |
|
|
227
|
-
| `docs/adr/` |
|
|
228
|
-
| `.env.example` |
|
|
223
|
+
| Document | When | Priority | Skill |
|
|
224
|
+
|----------|------|----------|-------|
|
|
225
|
+
| `reference/configuration.md` | Always | Critical | doc-write |
|
|
226
|
+
| `docs/guides/deployment.md` | If it affects deploy | High | doc-write |
|
|
227
|
+
| `docs/adr/` | If it is a significant infrastructure change | High | doc-write |
|
|
228
|
+
| `.env.example` | If variables were added | High | direct |
|
|
229
229
|
|
|
230
|
-
##
|
|
230
|
+
## Process Flow
|
|
231
231
|
|
|
232
|
-
###
|
|
232
|
+
### Step 1: Identify what changed
|
|
233
233
|
|
|
234
234
|
```bash
|
|
235
|
-
#
|
|
235
|
+
# Option A: Git diff
|
|
236
236
|
git diff --name-only HEAD~1 HEAD
|
|
237
237
|
git diff --name-only --staged
|
|
238
238
|
|
|
239
|
-
#
|
|
240
|
-
[
|
|
239
|
+
# Option B: Manual list of changed files
|
|
240
|
+
[list provided by agent/human]
|
|
241
241
|
```
|
|
242
242
|
|
|
243
|
-
###
|
|
243
|
+
### Step 2: Map changes to affected docs
|
|
244
244
|
|
|
245
245
|
```
|
|
246
|
-
|
|
247
|
-
├──
|
|
248
|
-
├──
|
|
249
|
-
├──
|
|
250
|
-
├──
|
|
251
|
-
├──
|
|
252
|
-
├──
|
|
253
|
-
└──
|
|
246
|
+
For each changed file:
|
|
247
|
+
├── Is it source code? → Check reference/, CONTEXT.md
|
|
248
|
+
├── Is it styles/CSS? → Check DESIGN.md
|
|
249
|
+
├── Is it configuration? → Check reference/configuration.md
|
|
250
|
+
├── Is it a new module? → Check CONTEXT.md, docs/README.md
|
|
251
|
+
├── Is it a fix? → Check CHANGELOG.md, troubleshooting
|
|
252
|
+
├── Is it infrastructure? → Check deployment.md, ADRs
|
|
253
|
+
└── Is it a test? → Generally no doc update needed
|
|
254
254
|
```
|
|
255
255
|
|
|
256
|
-
###
|
|
256
|
+
### Step 3: Update each affected doc
|
|
257
257
|
|
|
258
258
|
```
|
|
259
|
-
1.
|
|
260
|
-
2.
|
|
261
|
-
3.
|
|
262
|
-
4.
|
|
259
|
+
1. Open the affected doc file
|
|
260
|
+
2. Identify the section that needs changing
|
|
261
|
+
3. Make the change maintaining the existing format
|
|
262
|
+
4. Verify the change is consistent with the rest of the file
|
|
263
263
|
```
|
|
264
264
|
|
|
265
|
-
###
|
|
265
|
+
### Step 4: Verify consistency
|
|
266
266
|
|
|
267
267
|
```
|
|
268
|
-
1. CONTEXT.md:
|
|
269
|
-
2. docs/README.md:
|
|
270
|
-
3. ADRs:
|
|
271
|
-
4. DESIGN.md:
|
|
272
|
-
5. reference/api.md:
|
|
268
|
+
1. CONTEXT.md: Are the new terms there? Are removed ones marked?
|
|
269
|
+
2. docs/README.md: Does the map reflect current files?
|
|
270
|
+
3. ADRs: Do the changes invalidate any existing ADR?
|
|
271
|
+
4. DESIGN.md: Do tokens still match? (if styles changed)
|
|
272
|
+
5. reference/api.md: Do documented endpoints match the code?
|
|
273
273
|
```
|
|
274
274
|
|
|
275
|
-
###
|
|
275
|
+
### Step 5: Report what was updated
|
|
276
276
|
|
|
277
277
|
```
|
|
278
|
-
✅
|
|
279
|
-
- docs/CONTEXT.md:
|
|
280
|
-
- docs/README.md:
|
|
281
|
-
- reference/api.md:
|
|
282
|
-
|
|
283
|
-
ℹ️
|
|
284
|
-
- CHANGELOG.md: Feature
|
|
285
|
-
- DESIGN.md: No
|
|
278
|
+
✅ Documentation updated:
|
|
279
|
+
- docs/CONTEXT.md: Added 2 terms (UserService, RateLimit)
|
|
280
|
+
- docs/README.md: Added how-to/rate-limiting.md to map
|
|
281
|
+
- reference/api.md: Updated endpoint /api/users with new field
|
|
282
|
+
|
|
283
|
+
ℹ️ No changes needed:
|
|
284
|
+
- CHANGELOG.md: Feature not yet released
|
|
285
|
+
- DESIGN.md: No style changes
|
|
286
286
|
```
|
|
287
287
|
|
|
288
|
-
##
|
|
288
|
+
## Batch Updates
|
|
289
289
|
|
|
290
|
-
|
|
290
|
+
When multiple changes occur together (e.g., end of sprint):
|
|
291
291
|
|
|
292
292
|
```
|
|
293
|
-
1.
|
|
294
|
-
2.
|
|
295
|
-
3.
|
|
296
|
-
4.
|
|
293
|
+
1. List ALL changes since the last update
|
|
294
|
+
2. Group by trigger type (feature, refactor, fix, etc.)
|
|
295
|
+
3. Update each doc ONCE with all accumulated changes
|
|
296
|
+
4. Run doc-review at the end to verify consistency
|
|
297
297
|
```
|
|
298
298
|
|
|
299
|
-
###
|
|
299
|
+
### Example: End of sprint
|
|
300
300
|
|
|
301
301
|
```
|
|
302
|
-
|
|
303
|
-
- 3 features
|
|
304
|
-
- 1 refactor
|
|
302
|
+
Sprint changes:
|
|
303
|
+
- 3 new features
|
|
304
|
+
- 1 auth refactor
|
|
305
305
|
- 2 bug fixes
|
|
306
|
-
- 1
|
|
307
|
-
|
|
308
|
-
Docs
|
|
309
|
-
1. CHANGELOG.md →
|
|
310
|
-
2. CONTEXT.md →
|
|
311
|
-
3. reference/api.md →
|
|
312
|
-
4. docs/adr/ →
|
|
313
|
-
5. reference/configuration.md →
|
|
314
|
-
6. docs/README.md →
|
|
306
|
+
- 1 configuration change
|
|
307
|
+
|
|
308
|
+
Docs to update:
|
|
309
|
+
1. CHANGELOG.md → Complete sprint entry
|
|
310
|
+
2. CONTEXT.md → Terms from 3 features + auth refactor
|
|
311
|
+
3. reference/api.md → New endpoints
|
|
312
|
+
4. docs/adr/ → Auth refactor ADR (if applicable)
|
|
313
|
+
5. reference/configuration.md → Changed config
|
|
314
|
+
6. docs/README.md → If docs were added/removed
|
|
315
315
|
```
|
|
316
316
|
|
|
317
|
-
##
|
|
317
|
+
## Commands
|
|
318
318
|
|
|
319
|
-
###
|
|
319
|
+
### Identify changes
|
|
320
320
|
|
|
321
321
|
```bash
|
|
322
|
-
#
|
|
322
|
+
# Files modified in the last commit
|
|
323
323
|
git diff --name-only HEAD~1
|
|
324
324
|
|
|
325
|
-
#
|
|
325
|
+
# Modified files (staged + unstaged)
|
|
326
326
|
git diff --name-only; git diff --name-only --staged
|
|
327
327
|
|
|
328
|
-
#
|
|
328
|
+
# Changes in a range of commits
|
|
329
329
|
git diff --name-only commit1..commit2
|
|
330
330
|
```
|
|
331
331
|
|
|
332
|
-
###
|
|
332
|
+
### Post-update consistency verification
|
|
333
333
|
|
|
334
334
|
```
|
|
335
|
-
1.
|
|
336
|
-
2.
|
|
337
|
-
3.
|
|
338
|
-
4.
|
|
339
|
-
5.
|
|
335
|
+
1. Does CONTEXT.md have all the new terms from code?
|
|
336
|
+
2. Does docs/README.md list all existing doc files?
|
|
337
|
+
3. Are ADRs consistent with the current implementation?
|
|
338
|
+
4. Does DESIGN.md match current styles?
|
|
339
|
+
5. Does reference/api.md reflect current endpoints?
|
|
340
340
|
```
|
|
341
341
|
|
|
342
|
-
##
|
|
342
|
+
## Resources
|
|
343
343
|
|
|
344
|
-
- [Triggers Reference](references/triggers.md) —
|
|
345
|
-
-
|
|
344
|
+
- [Triggers Reference](references/triggers.md) — Complete table of events → docs to update with examples
|
|
345
|
+
- Related skills: `doc-write` (write/update docs), `doc-review` (audit after updating), `doc-design` (update DESIGN.md), `doc-scaffold` (if structure is missing)
|