@damenor/agent-docs 0.1.2 → 0.4.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.
Files changed (41) hide show
  1. package/README.md +65 -29
  2. package/dist/index.js +3834 -217
  3. package/package.json +5 -2
  4. package/templates/modules/agents/.agents/agents/doc-designer.md +39 -37
  5. package/templates/modules/agents/.agents/agents/doc-maintainer.md +35 -35
  6. package/templates/modules/agents/.agents/agents/doc-reviewer.md +55 -46
  7. package/templates/modules/agents/.agents/agents/doc-writer.md +34 -33
  8. package/templates/modules/agents/.agents/agents/reviewer.md +114 -100
  9. package/templates/modules/agents/.agents/skills/doc-design/SKILL.md +176 -174
  10. package/templates/modules/agents/.agents/skills/doc-design/references/design-system-format.md +241 -247
  11. package/templates/modules/agents/.agents/skills/doc-maintain/SKILL.md +61 -51
  12. package/templates/modules/agents/.agents/skills/doc-maintain/references/triggers.md +171 -165
  13. package/templates/modules/agents/.agents/skills/doc-review/SKILL.md +39 -34
  14. package/templates/modules/agents/.agents/skills/doc-review/references/health-checklist.md +115 -112
  15. package/templates/modules/agents/.agents/skills/doc-scaffold/SKILL.md +19 -12
  16. package/templates/modules/agents/.agents/skills/doc-scaffold/references/diataxis-quick-ref.md +110 -110
  17. package/templates/modules/agents/.agents/skills/doc-write/SKILL.md +44 -16
  18. package/templates/modules/agents/.agents/skills/doc-write/references/adr-format.md +99 -93
  19. package/templates/modules/agents/.agents/skills/doc-write/references/diataxis-patterns.md +221 -200
  20. package/templates/base/AGENTS.md +0 -177
  21. package/templates/base/CHANGELOG.md +0 -86
  22. package/templates/base/README.md +0 -105
  23. package/templates/base/docs/CONTEXT.md +0 -111
  24. package/templates/base/docs/README.md +0 -131
  25. package/templates/base/docs/adr/TEMPLATE.md +0 -83
  26. package/templates/modules/design/docs/DESIGN.md +0 -253
  27. package/templates/modules/explanation/docs/explanation/agent-flow.md +0 -15
  28. package/templates/modules/explanation/docs/explanation/architecture.md +0 -138
  29. package/templates/modules/guides/docs/guides/deployment.md +0 -189
  30. package/templates/modules/guides/docs/guides/runbooks/TEMPLATE.md +0 -86
  31. package/templates/modules/guides/docs/guides/troubleshooting.md +0 -65
  32. package/templates/modules/operations/docs/operations/README.md +0 -115
  33. package/templates/modules/product/docs/product/overview.md +0 -90
  34. package/templates/modules/product/docs/roadmap.md +0 -80
  35. package/templates/modules/reference/docs/reference/api.md +0 -131
  36. package/templates/modules/reference/docs/reference/code-style.md +0 -275
  37. package/templates/modules/reference/docs/reference/configuration.md +0 -117
  38. package/templates/modules/reference/docs/reference/infrastructure.md +0 -191
  39. package/templates/modules/tutorials/docs/tutorials/environment-setup.md +0 -212
  40. package/templates/modules/tutorials/docs/tutorials/first-task.md +0 -246
  41. package/templates/modules/tutorials/docs/tutorials/quick-start.md +0 -146
@@ -11,7 +11,7 @@ description: >
11
11
  license: Apache-2.0
12
12
  metadata:
13
13
  author: damenordev
14
- version: "1.0"
14
+ version: '1.0'
15
15
  ---
16
16
 
17
17
  # doc-maintain
@@ -75,15 +75,15 @@ Not clear which docs are affected?
75
75
 
76
76
  **Docs to update**:
77
77
 
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 |
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
 
@@ -91,27 +91,32 @@ Not clear which docs are affected?
91
91
 
92
92
  **Docs to update**:
93
93
 
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 |
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
103
  ```markdown
103
104
  ## [X.Y.Z] - YYYY-MM-DD
104
105
 
105
106
  ### Added
107
+
106
108
  - Description of new feature
107
109
 
108
110
  ### Changed
111
+
109
112
  - Description of change
110
113
 
111
114
  ### Fixed
115
+
112
116
  - Description of fix
113
117
 
114
118
  ### Breaking
119
+
115
120
  - ⚠️ Description of breaking change
116
121
  ```
117
122
 
@@ -121,18 +126,19 @@ Not clear which docs are affected?
121
126
 
122
127
  **Docs to update**:
123
128
 
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 |
129
+ | Document | When | Priority | Skill |
130
+ | --------------------------------------------- | ------------------------------------------- | -------- | --------- |
131
+ | `operations/post-mortems/YYYY-MM-DD-title.md` | Always | Critical | doc-write |
132
+ | `operations/runbooks/` | If there are resolution steps to repeat | High | doc-write |
133
+ | `docs/CONTEXT.md` | If domain terms were discovered | Medium | doc-write |
134
+ | `reference/configuration.md` | If configs were changed during the incident | High | doc-write |
135
+ | `how-to/troubleshooting.md` | If the fix is applicable in the future | High | doc-write |
131
136
 
132
137
  **Post-mortem format**:
138
+
133
139
  ```markdown
134
140
  ---
135
- created: "YYYY-MM-DD"
141
+ created: 'YYYY-MM-DD'
136
142
  status: active
137
143
  type: explanation
138
144
  tags: [post-mortem, incident, sev-N]
@@ -146,19 +152,23 @@ tags: [post-mortem, incident, sev-N]
146
152
  **Impact**: Description of user impact
147
153
 
148
154
  ## Timeline
155
+
149
156
  - HH:MM — Detection
150
157
  - HH:MM — Diagnosis
151
158
  - HH:MM — Mitigation
152
159
  - HH:MM — Resolution
153
160
 
154
161
  ## Root cause
162
+
155
163
  [Description]
156
164
 
157
165
  ## Preventive actions
166
+
158
167
  - [ ] [Action 1] — Responsible — Deadline
159
168
  - [ ] [Action 2] — Responsible — Deadline
160
169
 
161
170
  ## Lessons learned
171
+
162
172
  [What we learned]
163
173
  ```
164
174
 
@@ -168,13 +178,13 @@ tags: [post-mortem, incident, sev-N]
168
178
 
169
179
  **Docs to update**:
170
180
 
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 |
181
+ | Document | When | Priority | Skill |
182
+ | ---------------------------------- | ---------------------------------------- | -------- | --------- |
183
+ | `docs/adr/` | If the refactor implies a pattern change | High | doc-write |
184
+ | `docs/explanation/architecture.md` | If the architecture changed | High | doc-write |
185
+ | `docs/CONTEXT.md` | If names/terms changed | Critical | doc-write |
186
+ | `docs/README.md` | If files were moved | Medium | doc-write |
187
+ | Existing ADRs | Verify they are still valid | High | doc-write |
178
188
 
179
189
  ### Post-hire
180
190
 
@@ -182,11 +192,11 @@ tags: [post-mortem, incident, sev-N]
182
192
 
183
193
  **Docs to update**:
184
194
 
185
- | Document | When | Priority | Skill |
186
- |----------|------|----------|-------|
195
+ | Document | When | Priority | Skill |
196
+ | -------------------------- | ------------------------------------------- | -------- | --------- |
187
197
  | `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 |
198
+ | `docs/CONTEXT.md` | If the new dev found confusing terms | High | doc-write |
199
+ | Any doc | If the new dev found incorrect info | High | doc-write |
190
200
 
191
201
  ### Post-design-change
192
202
 
@@ -194,10 +204,10 @@ tags: [post-mortem, incident, sev-N]
194
204
 
195
205
  **Docs to update**:
196
206
 
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 |
207
+ | Document | When | Priority | Skill |
208
+ | ----------------- | ----------------------------- | -------- | ---------- |
209
+ | `DESIGN.md` | Always | Critical | doc-design |
210
+ | `docs/CONTEXT.md` | If there are new design terms | Medium | doc-write |
201
211
 
202
212
  **Use skill `doc-design`** to re-extract tokens and update DESIGN.md.
203
213
 
@@ -207,12 +217,12 @@ tags: [post-mortem, incident, sev-N]
207
217
 
208
218
  **Docs to update**:
209
219
 
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 |
220
+ | Document | When | Priority | Skill |
221
+ | ------------------ | ----------------------------- | -------- | --------- |
222
+ | `reference/api.md` | Always | Critical | doc-write |
223
+ | `CHANGELOG.md` | If there are breaking changes | Critical | doc-write |
224
+ | `docs/adr/` | If the API structure changed | High | doc-write |
225
+ | `how-to/` | If there are new usage flows | Medium | doc-write |
216
226
 
217
227
  ### Post-config-change
218
228
 
@@ -220,12 +230,12 @@ tags: [post-mortem, incident, sev-N]
220
230
 
221
231
  **Docs to update**:
222
232
 
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 |
233
+ | Document | When | Priority | Skill |
234
+ | ---------------------------- | -------------------------------------------- | -------- | --------- |
235
+ | `reference/configuration.md` | Always | Critical | doc-write |
236
+ | `docs/guides/deployment.md` | If it affects deploy | High | doc-write |
237
+ | `docs/adr/` | If it is a significant infrastructure change | High | doc-write |
238
+ | `.env.example` | If variables were added | High | direct |
229
239
 
230
240
  ## Process Flow
231
241