codymaster 4.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.
Files changed (193) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/README.md +285 -0
  3. package/adapters/antigravity.js +15 -0
  4. package/adapters/claude-code.js +17 -0
  5. package/adapters/cursor.js +16 -0
  6. package/commands/bootstrap.md +49 -0
  7. package/commands/build.md +48 -0
  8. package/commands/content.md +48 -0
  9. package/commands/continuity.md +60 -0
  10. package/commands/debug.md +51 -0
  11. package/commands/demo.md +96 -0
  12. package/commands/deploy.md +51 -0
  13. package/commands/plan.md +42 -0
  14. package/commands/review.md +55 -0
  15. package/commands/track.md +46 -0
  16. package/commands/ux.md +46 -0
  17. package/dist/agent-dispatch.js +161 -0
  18. package/dist/chains/builtin.js +85 -0
  19. package/dist/continuity.js +385 -0
  20. package/dist/dashboard.js +926 -0
  21. package/dist/data.js +122 -0
  22. package/dist/index.js +2434 -0
  23. package/dist/judge.js +252 -0
  24. package/dist/parallel-dispatch.js +359 -0
  25. package/dist/parallel-quality.js +172 -0
  26. package/dist/skill-chain.js +258 -0
  27. package/install.sh +513 -0
  28. package/package.json +79 -0
  29. package/skills/.content-factory-state.json +132 -0
  30. package/skills/.git 2/logs/refs/heads/main +1 -0
  31. package/skills/.git 2/logs/refs/remotes/origin/main +1 -0
  32. package/skills/.git 2/objects/02/fb0956734b5f8ba3f918b7defd04a89cfe0076 +0 -0
  33. package/skills/.git 2/objects/08/1e129d75dc6feac6c02037272e6bd1a04e3324 +0 -0
  34. package/skills/.git 2/objects/0c/5393416f3c5e01c9a655a802bff0dd52f76f0a +0 -0
  35. package/skills/.git 2/objects/10/0b9be46978a946a77188f68be725098a122001 +0 -0
  36. package/skills/.git 2/objects/10/cf041167fc9843610eb3d90259ef3396315fdc +0 -0
  37. package/skills/.git 2/objects/12/5e19538dd6e1338ffe74f6c4c165b00435bf48 +0 -0
  38. package/skills/.git 2/objects/16/a9b9d0088d5c1347628b45a2620b479d8ad57c +0 -0
  39. package/skills/.git 2/objects/17/8c2a9ef93c33ae4eec9d58e82321f9229843a1 +0 -0
  40. package/skills/.git 2/objects/25/397ae41d09104d763bdcac2695209d85cdea89 +0 -0
  41. package/skills/.git 2/objects/2f/a836b7947f2d458e1f639788bf4bb0983a3305 +0 -0
  42. package/skills/.git 2/objects/3a/baaaf0a1c0909c0828335791557125fba911e0 +0 -0
  43. package/skills/.git 2/objects/42/2924221b81f5ce3c4e4daac9a64a24f9b01f9a +0 -0
  44. package/skills/.git 2/objects/42/ec0ce707447dc11446a34c9995fb8533801731 +0 -0
  45. package/skills/.git 2/objects/46/e43ce92866d56ce74b1d750db307cfe6154a15 +0 -0
  46. package/skills/.git 2/objects/48/5e41b633c63f55b8277bcc59f44f67681f671a +0 -0
  47. package/skills/.git 2/objects/49/49c596a3a89fa240642acd95dd3258e261eb09 +0 -0
  48. package/skills/.git 2/objects/50/9d42d8412ef8eaf7f7e138476bac2e4d10ce60 +0 -0
  49. package/skills/.git 2/objects/55/0c8c389d981b463ef849aeb792d8be3ccb6ec8 +0 -0
  50. package/skills/.git 2/objects/5d/82d3b18410cdda3ace3677436f0cb599dbe2d2 +0 -0
  51. package/skills/.git 2/objects/60/0617c58e871a38b33bf29e282d132bb3c381ad +0 -0
  52. package/skills/.git 2/objects/6a/8369a99c687b7245c92ffaf0e0f0dab9014504 +0 -0
  53. package/skills/.git 2/objects/79/bea435d40ab531c1aaf6be0432c6a5b7aaed21 +0 -0
  54. package/skills/.git 2/objects/7e/5ebd79251c2f14e4aceb86c74b6b6daae6b500 +0 -0
  55. package/skills/.git 2/objects/81/98a822a60178d6d5023ddb3e222cddf048742e +0 -0
  56. package/skills/.git 2/objects/86/0a0e1943dfe53411d2e499a1f16f46a96ef758 +0 -0
  57. package/skills/.git 2/objects/86/971fb55fdc081fdbae52376f0f13e57a4e9b04 +0 -0
  58. package/skills/.git 2/objects/88/b89dd609a0a03f8d4fe8bfde20d5b8fc1d326d +0 -0
  59. package/skills/.git 2/objects/90/8737edb6b7809e32cc01590b4e08ba42a9d40d +0 -0
  60. package/skills/.git 2/objects/93/d5a8a9a7d4fb7f11491cb596a6880528725118 +0 -0
  61. package/skills/.git 2/objects/98/46a2ab81d0c3b3eb00ef88fc56989aa7e9f316 +0 -0
  62. package/skills/.git 2/objects/9b/d8dd1e49cf274eaf9c555f3ab39dce7af5715e +0 -0
  63. package/skills/.git 2/objects/a1/13329fb0cec96ae78b222d33a24c3b5bc7fa1f +0 -0
  64. package/skills/.git 2/objects/a9/e6effe626e8a3aea3a8fc3364b492191c6e7d0 +0 -0
  65. package/skills/.git 2/objects/ad/6de7e48d9782cca9353d1ff0aa1aab7fe1df85 +0 -0
  66. package/skills/.git 2/objects/af/54ae316f771ff692e299ffcd8bf2f06b413b59 +0 -0
  67. package/skills/.git 2/objects/b0/4cb8b0b00dad633e731c1472161419e738d674 +0 -0
  68. package/skills/.git 2/objects/b3/094abb0b9ed46419b269e4a4e36a459690e3b0 +0 -0
  69. package/skills/.git 2/objects/b9/435c5d4baac2cfc5c83009ddd27b46b60db5f1 +0 -0
  70. package/skills/.git 2/objects/ba/5da17dbaec5ec2dcfdfd126aead518d1171d5c +0 -0
  71. package/skills/.git 2/objects/c0/bf58703aa258ba5dd63083bebaec8f223d844c +0 -0
  72. package/skills/.git 2/objects/c4/701a34edf1fc1bad58ccc57bd03f9426acb59a +0 -0
  73. package/skills/.git 2/objects/c7/5ccce9a4e5cc74d9b3174550cf6d993ca43638 +0 -0
  74. package/skills/.git 2/objects/c7/710d59b5a35b0f1f0a0399386643a0bd94c929 +0 -0
  75. package/skills/.git 2/objects/d1/fe58237112e953e5fec52da22cf38e08be3df9 +5 -0
  76. package/skills/.git 2/objects/d2/2bbe9fd2f74c95bc5583e803f5e435f1e2cd86 +0 -0
  77. package/skills/.git 2/objects/d7/e72852ea2bff74581dbf247d400120086229f4 +0 -0
  78. package/skills/.git 2/objects/d8/d4c3b5553e4fd72807e1d4b49ef07d9ef3ac35 +0 -0
  79. package/skills/.git 2/objects/dc/75050c2876f6a02ae2a53a3c886f395b622977 +0 -0
  80. package/skills/.git 2/objects/ee/e8546f95acec500187c08a28a8b9ee02db0dec +0 -0
  81. package/skills/.git 2/objects/ef/263c059208b416c2146434f10cb2b9fabcba16 +0 -0
  82. package/skills/.git 2/objects/f3/ae597e84d9a59b88acd21c99bde2eaf686d785 +0 -0
  83. package/skills/.git 2/objects/f3/f6f5673c821d3d8e76fa267a9e882e7a5387ea +0 -0
  84. package/skills/.git 2/objects/f9/6e6d0ad02624dd11d5848594d056caef7a5e8b +0 -0
  85. package/skills/.git 2/objects/ff/278988fc1edf0db3abcf18de795f4cc0b4f3e1 +0 -0
  86. package/skills/.git 2/refs/heads/main +1 -0
  87. package/skills/.git 2/refs/remotes/origin/main +1 -0
  88. package/skills/.pytest_cache 2/v/cache/nodeids +76 -0
  89. package/skills/.pytest_cache 2/v/cache/stepwise +1 -0
  90. package/skills/_shared/helpers.md +123 -0
  91. package/skills/_shared/outputs-convention.md +24 -0
  92. package/skills/cm-ads-tracker/SKILL.md +109 -0
  93. package/skills/cm-ads-tracker/evals/evals.json +55 -0
  94. package/skills/cm-ads-tracker/references/gtm-architecture.md +321 -0
  95. package/skills/cm-ads-tracker/references/industry-events.md +294 -0
  96. package/skills/cm-ads-tracker/references/platforms-api.md +238 -0
  97. package/skills/cm-ads-tracker/templates/capi-payload.md +79 -0
  98. package/skills/cm-ads-tracker/templates/datalayer-push.js +104 -0
  99. package/skills/cm-ads-tracker/templates/gtm-variables.js +56 -0
  100. package/skills/cm-brainstorm-idea/SKILL.md +423 -0
  101. package/skills/cm-code-review/SKILL.md +151 -0
  102. package/skills/cm-content-factory/SKILL.md +416 -0
  103. package/skills/cm-continuity/SKILL.md +399 -0
  104. package/skills/cm-dashboard/SKILL.md +533 -0
  105. package/skills/cm-dashboard/ui/app.js +1270 -0
  106. package/skills/cm-dashboard/ui/index.html +206 -0
  107. package/skills/cm-dashboard/ui/style.css +440 -0
  108. package/skills/cm-debugging/SKILL.md +412 -0
  109. package/skills/cm-deep-search/SKILL.md +242 -0
  110. package/skills/cm-design-system/SKILL.md +97 -0
  111. package/skills/cm-design-system/resources/halo-modern.md +40 -0
  112. package/skills/cm-design-system/resources/lunaris-advanced.md +40 -0
  113. package/skills/cm-design-system/resources/nitro-enterprise.md +39 -0
  114. package/skills/cm-design-system/resources/shadcn-default.md +37 -0
  115. package/skills/cm-dockit/README.md +100 -0
  116. package/skills/cm-dockit/SKILL.md +302 -0
  117. package/skills/cm-dockit/index.html +443 -0
  118. package/skills/cm-dockit/package-lock.json +1850 -0
  119. package/skills/cm-dockit/package.json +14 -0
  120. package/skills/cm-dockit/prompts/analysis.md +34 -0
  121. package/skills/cm-dockit/prompts/api-reference.md +24 -0
  122. package/skills/cm-dockit/prompts/architecture.md +21 -0
  123. package/skills/cm-dockit/prompts/data-flow.md +20 -0
  124. package/skills/cm-dockit/prompts/database.md +21 -0
  125. package/skills/cm-dockit/prompts/deployment.md +22 -0
  126. package/skills/cm-dockit/prompts/flows.md +21 -0
  127. package/skills/cm-dockit/prompts/jtbd.md +20 -0
  128. package/skills/cm-dockit/prompts/personas.md +24 -0
  129. package/skills/cm-dockit/prompts/sop-modules.md +40 -0
  130. package/skills/cm-dockit/scripts/doc-gen.sh +121 -0
  131. package/skills/cm-dockit/scripts/dockit-dashboard.sh +142 -0
  132. package/skills/cm-dockit/scripts/dockit-runner.sh +607 -0
  133. package/skills/cm-dockit/scripts/dockit-task.sh +166 -0
  134. package/skills/cm-dockit/skills/analyze-codebase.md +174 -0
  135. package/skills/cm-dockit/skills/api-reference.md +237 -0
  136. package/skills/cm-dockit/skills/changelog-guide.md +195 -0
  137. package/skills/cm-dockit/skills/content-guidelines.md +190 -0
  138. package/skills/cm-dockit/skills/sop-guide.md +184 -0
  139. package/skills/cm-dockit/skills/tech-docs.md +287 -0
  140. package/skills/cm-dockit/templates/markdown/structure.md +60 -0
  141. package/skills/cm-dockit/templates/vitepress-premium/.vitepress/config.mts +110 -0
  142. package/skills/cm-dockit/templates/vitepress-premium/.vitepress/theme/custom.css +189 -0
  143. package/skills/cm-dockit/templates/vitepress-premium/.vitepress/theme/index.ts +4 -0
  144. package/skills/cm-dockit/templates/vitepress-premium/package.json +19 -0
  145. package/skills/cm-dockit/templates/vitepress-premium/tests/frontend.test.ts +45 -0
  146. package/skills/cm-dockit/tests/runner.test.ts +66 -0
  147. package/skills/cm-dockit/workflows/export-markdown.md +82 -0
  148. package/skills/cm-dockit/workflows/generate-docs.md +68 -0
  149. package/skills/cm-dockit/workflows/setup-vitepress.md +181 -0
  150. package/skills/cm-example/SKILL.md +26 -0
  151. package/skills/cm-execution/SKILL.md +268 -0
  152. package/skills/cm-git-worktrees/SKILL.md +164 -0
  153. package/skills/cm-how-it-work/SKILL.md +189 -0
  154. package/skills/cm-identity-guard/SKILL.md +412 -0
  155. package/skills/cm-jtbd/SKILL.md +98 -0
  156. package/skills/cm-planning/SKILL.md +130 -0
  157. package/skills/cm-project-bootstrap/SKILL.md +161 -0
  158. package/skills/cm-project-bootstrap/templates/AGENTS.md +42 -0
  159. package/skills/cm-project-bootstrap/templates/frontend-safety.test.js +51 -0
  160. package/skills/cm-project-bootstrap/templates/i18n-sync.test.js +38 -0
  161. package/skills/cm-project-bootstrap/templates/pr-template.md +12 -0
  162. package/skills/cm-project-bootstrap/templates/project-identity.json +29 -0
  163. package/skills/cm-project-bootstrap/templates/vitest.config.js +10 -0
  164. package/skills/cm-quality-gate/SKILL.md +218 -0
  165. package/skills/cm-readit/SKILL.md +289 -0
  166. package/skills/cm-readit/audio-player.md +206 -0
  167. package/skills/cm-readit/examples/blog-reader.js +352 -0
  168. package/skills/cm-readit/examples/voice-cro.js +390 -0
  169. package/skills/cm-readit/tts-engine.md +262 -0
  170. package/skills/cm-readit/ui-patterns.md +362 -0
  171. package/skills/cm-readit/voice-cro.md +223 -0
  172. package/skills/cm-safe-deploy/SKILL.md +120 -0
  173. package/skills/cm-safe-deploy/templates/deploy.sh +89 -0
  174. package/skills/cm-safe-i18n/SKILL.md +473 -0
  175. package/skills/cm-secret-shield/SKILL.md +580 -0
  176. package/skills/cm-skill-chain/SKILL.md +78 -0
  177. package/skills/cm-skill-index/SKILL.md +318 -0
  178. package/skills/cm-skill-mastery/SKILL.md +169 -0
  179. package/skills/cm-start/SKILL.md +65 -0
  180. package/skills/cm-status/SKILL.md +12 -0
  181. package/skills/cm-tdd/SKILL.md +370 -0
  182. package/skills/cm-terminal/SKILL.md +177 -0
  183. package/skills/cm-test-gate/SKILL.md +242 -0
  184. package/skills/cm-ui-preview/SKILL.md +291 -0
  185. package/skills/cm-ux-master/DESIGN_STANDARD_TEMPLATE.md +54 -0
  186. package/skills/cm-ux-master/SKILL.md +114 -0
  187. package/skills/cro-methodology/SKILL.md +98 -0
  188. package/skills/cro-methodology/references/COPYWRITING.md +178 -0
  189. package/skills/cro-methodology/references/OBJECTIONS.md +135 -0
  190. package/skills/cro-methodology/references/PERSUASION.md +158 -0
  191. package/skills/cro-methodology/references/RESEARCH.md +220 -0
  192. package/skills/cro-methodology/references/funnel-analysis.md +365 -0
  193. package/skills/cro-methodology/references/testing-methodology.md +330 -0
@@ -0,0 +1,195 @@
1
+ # Changelog Documentation Guide
2
+
3
+ Sub-skill for `cm-dockit` — generates structured changelog documentation from git history or existing `CHANGELOG.md`.
4
+
5
+ ## When to Use
6
+
7
+ - User requests `changelog` doc type in DocKit
8
+ - Part of `all` doc type generation sequence
9
+ - User asks for "release notes", "version history", "changelog page"
10
+ - After `cm-safe-deploy` Gate 8 generates `CHANGELOG.md`
11
+
12
+ ## Changelog Categories (2 Types Only)
13
+
14
+ | Category | Icon | Keywords |
15
+ |----------|------|----------|
16
+ | **Improvements** | 🚀 | `feat:`, `add:`, `improve:`, `enhance:`, `refactor:`, `perf:`, `style:`, `chore:`, `docs:` |
17
+ | **Bug Fixes** | 🐛 | `fix:`, `bug:`, `patch:`, `hotfix:`, `correct` |
18
+
19
+ > [!IMPORTANT]
20
+ > Only 2 categories. No "Breaking Changes", no "Deprecations". Keep it simple.
21
+
22
+ ## Data Sources (Priority Order)
23
+
24
+ 1. **`CHANGELOG.md` at project root** — If exists, read and convert to docs format (preferred, generated by `cm-safe-deploy` Gate 8)
25
+ 2. **Git tags + commit history** — If no CHANGELOG.md, generate from `git tag` and `git log`
26
+ 3. **Manual input** — If no git history available, ask user for release notes
27
+
28
+ ## Output
29
+
30
+ ### File: `docs/changelog.md`
31
+
32
+ ```markdown
33
+ ---
34
+ title: Changelog - [Project Name]
35
+ description: Release history and version notes for [Project Name]
36
+ keywords: [changelog, release notes, version history, updates]
37
+ robots: "index, follow"
38
+ ---
39
+
40
+ # Changelog
41
+
42
+ All notable changes to this project are documented here.
43
+
44
+ Categories: 🚀 **Improvements** | 🐛 **Bug Fixes**
45
+
46
+ ## [X.Y.Z] - YYYY-MM-DD
47
+
48
+ ### 🚀 Improvements
49
+ - Description of feature or enhancement (commit-hash)
50
+
51
+ ### 🐛 Bug Fixes
52
+ - Description of bug fix (commit-hash)
53
+
54
+ ---
55
+
56
+ ## [X.Y.Z-1] - YYYY-MM-DD
57
+
58
+ ### 🚀 Improvements
59
+ - ...
60
+
61
+ ### 🐛 Bug Fixes
62
+ - ...
63
+ ```
64
+
65
+ ## Generation Procedure
66
+
67
+ ### Step 1: Check for CHANGELOG.md
68
+
69
+ ```
70
+ IF CHANGELOG.md exists at project root:
71
+ → Read and parse it
72
+ → Convert to docs/changelog.md with VitePress frontmatter
73
+ → Preserve all version entries
74
+
75
+ ELSE IF git tags exist:
76
+ → Generate changelog from git history
77
+ → For each tag, collect commits between tags
78
+ → Categorize each commit into Improvements or Bug Fixes
79
+ → Write docs/changelog.md
80
+
81
+ ELSE:
82
+ → Create empty changelog template
83
+ → Ask user to provide release notes manually
84
+ ```
85
+
86
+ ### Step 2: Categorize Commits
87
+
88
+ For each commit message, auto-categorize:
89
+
90
+ ```javascript
91
+ function categorize(message) {
92
+ const lower = message.toLowerCase();
93
+ const fixKeywords = ['fix', 'bug', 'patch', 'hotfix', 'correct'];
94
+
95
+ if (fixKeywords.some(k => lower.includes(k))) {
96
+ return 'fix'; // 🐛 Bug Fixes
97
+ }
98
+ return 'improvement'; // 🚀 Improvements (default)
99
+ }
100
+ ```
101
+
102
+ **Rules:**
103
+ - If a commit contains BOTH improvement and fix keywords → classify as 🐛 Bug Fixes (conservative)
104
+ - If commit has no recognizable prefix → default to 🚀 Improvements
105
+ - Merge commits and `chore: bump version` should be excluded from changelog
106
+
107
+ ### Step 3: VitePress Integration
108
+
109
+ If output format is `vitepress`, add changelog to sidebar:
110
+
111
+ ```javascript
112
+ // In .vitepress/config.mts sidebar configuration
113
+ {
114
+ text: 'Changelog',
115
+ link: '/changelog'
116
+ }
117
+ ```
118
+
119
+ Add to navigation if not already present.
120
+
121
+ ### Step 4: Content Guidelines
122
+
123
+ Apply standard `cm-dockit` content guidelines:
124
+ - YAML frontmatter with `title`, `description`, `keywords`, `robots`
125
+ - Use `:::info` admonition for version highlights
126
+ - Use `<details>` for older versions (progressive disclosure — Hick's Law)
127
+ - Cross-link to related docs (architecture changes → `architecture.md`, API changes → `api/`)
128
+ - Minimum 2 internal links per page
129
+
130
+ ### Step 5: Validate
131
+
132
+ - ✅ Every version entry has a date in `YYYY-MM-DD` format
133
+ - ✅ Versions are sorted newest-first
134
+ - ✅ Each version has at least one entry in either category
135
+ - ✅ No duplicate version numbers
136
+ - ✅ Frontmatter is present and valid
137
+
138
+ ## Integration with cm-safe-deploy
139
+
140
+ ```
141
+ cm-safe-deploy Gate 8 cm-dockit changelog
142
+ │ │
143
+ ├─ Generates CHANGELOG.md ────►├─ Reads CHANGELOG.md
144
+ ├─ Creates git tag ├─ Converts to docs/changelog.md
145
+ ├─ Commits changelog ├─ Adds VitePress frontmatter
146
+ │ ├─ Categorizes into 🚀/🐛
147
+ │ └─ Adds to sidebar
148
+
149
+
150
+ Closed-loop release process
151
+ ```
152
+
153
+ ## Example: Full Changelog Page
154
+
155
+ ```markdown
156
+ ---
157
+ title: Changelog - CodyMaster
158
+ description: Complete release history for CodyMaster skill kit
159
+ keywords: [changelog, releases, updates, CodyMaster]
160
+ robots: "index, follow"
161
+ ---
162
+
163
+ # Changelog
164
+
165
+ > All notable changes to CodyMaster are documented here.
166
+
167
+ Categories: 🚀 **Improvements** | 🐛 **Bug Fixes**
168
+
169
+ ## [3.5.0] - 2026-03-23
170
+
171
+ ### 🚀 Improvements
172
+ - Add version bump gate to deploy pipeline (a1b2c3d)
173
+ - Upgrade changelog generation in cm-dockit (e4f5g6h)
174
+ - Add 9-gate pipeline visualization (i7j8k9l)
175
+
176
+ ### 🐛 Bug Fixes
177
+ - Fix i18n key parity check for Thai language (m0n1o2p)
178
+ - Fix FAQ card spacing on mobile (q3r4s5t)
179
+
180
+ ---
181
+
182
+ <details>
183
+ <summary>📦 Older Releases</summary>
184
+
185
+ ## [3.4.0] - 2026-03-20
186
+
187
+ ### 🚀 Improvements
188
+ - Multi-country upgrade for VN, TH, PH
189
+ - Smart Import Engine v2
190
+
191
+ ### 🐛 Bug Fixes
192
+ - Fix employee period score calculation
193
+
194
+ </details>
195
+ ```
@@ -0,0 +1,190 @@
1
+ # Content Quality Guidelines — UX Master Edition
2
+
3
+ Rules for generating documentation content that is readable, scannable, and compatible with VitePress.
4
+
5
+ ## UX Laws for Documentation
6
+
7
+ ### Hick's Law — Reduce Decision Complexity
8
+
9
+ - **Max 7 items** in any Table of Contents (TOC) top level
10
+ - **Max 2 primary CTAs** per page (e.g., "Get Started" + "View API")
11
+ - Group related items into categories — never flat-list >10 items
12
+ - Use **sidebar categories** instead of one long sidebar
13
+
14
+ ### Miller's Law — Chunk Information
15
+
16
+ - **Chunk tables** into groups of 5-9 rows with section headers
17
+ - **Break long pages** into sub-pages if >500 lines
18
+ - Use **visual separators**: `---`, headings, or admonition boxes
19
+ - Each section should be independently scannable
20
+
21
+ ### Doherty Threshold — Optimize for Scanning
22
+
23
+ - **Lead with a summary** — put the most important info first
24
+ - **Use tables** instead of long paragraphs for structured data
25
+ - **Bold key terms** in definitions and descriptions
26
+ - **Code examples** should be runnable as-is (copy-paste friendly)
27
+
28
+ ### Jakob's Law — Follow Familiar Patterns
29
+
30
+ - Use **standard doc layouts**: sidebar left, content center, TOC right
31
+ - Use **conventional heading hierarchy**: H1 (title) → H2 (sections) → H3 (subsections)
32
+ - Use **standard admonition types**: tip, info, warning, danger
33
+
34
+ ---
35
+
36
+ ## Filenames
37
+
38
+ | Rule | ✅ Correct | ❌ Wrong |
39
+ |------|-----------| ---------|
40
+ | **kebab-case** | `getting-started.md` | `Getting_Started.md` |
41
+ | **No underscore prefix** | `analysis.md` | `_analysis.md` |
42
+ | **No dots in names** | `deploy-guide.md` | `Deploy.vi.md` |
43
+ | **Lowercase only** | `api-reference.md` | `API_Reference.md` |
44
+
45
+ ## Frontmatter (Required)
46
+
47
+ Every `.md` file MUST include:
48
+
49
+ ```yaml
50
+ ---
51
+ title: "Descriptive Page Title"
52
+ description: "Brief 1-line description for SEO"
53
+ ---
54
+ ```
55
+
56
+ > **Note:** VitePress generates sidebar from file structure — no `sidebar_position` needed.
57
+
58
+ ## Links
59
+
60
+ - Use **relative paths**: `[API](./api-reference.md)` not absolute
61
+ - **Anchor links** must match actual heading slugs
62
+ - **No `<a>` tags** — use Markdown `[text](url)` syntax
63
+
64
+ ---
65
+
66
+ ## Content Structure Rules
67
+
68
+ ### Quick Reference Card (Required for tech docs)
69
+
70
+ Every technical document MUST start with a summary box:
71
+
72
+ ```markdown
73
+ > **Quick Reference**
74
+ > - **What**: Brief description of this system/feature
75
+ > - **Stack**: Python 3.10+, PyTorch 2.0, CUDA 12
76
+ > - **Key Files**: `src/engine.py`, `src/model.py`
77
+ > - **Status**: Production / Beta / Experimental
78
+ ```
79
+
80
+ ### Admonitions (Custom Containers)
81
+
82
+ VitePress supports these custom containers natively:
83
+
84
+ ```markdown
85
+ :::tip Performance Tip
86
+ Use batch processing for >100 items — 3x faster than sequential.
87
+ :::
88
+
89
+ :::info
90
+ This feature requires Python 3.10 or later.
91
+ :::
92
+
93
+ :::warning Breaking Change
94
+ This API changed in v2.0. See migration guide.
95
+ :::
96
+
97
+ :::danger Security
98
+ Never expose API keys in client-side code.
99
+ :::
100
+
101
+ :::details Advanced Configuration Options
102
+ | Option | Default | Description |
103
+ |--------|---------|-------------|
104
+ | `batch_size` | 32 | Processing batch size |
105
+ | `num_workers` | 4 | Parallel worker count |
106
+ :::
107
+ ```
108
+
109
+ ### Code Groups (Multi-Platform Examples)
110
+
111
+ Use VitePress code groups instead of HTML tabs:
112
+
113
+ ```markdown
114
+ ::: code-group
115
+
116
+ \```bash [macOS]
117
+ brew install myapp
118
+ \```
119
+
120
+ \```bash [Linux]
121
+ apt-get install myapp
122
+ \```
123
+
124
+ \```bash [Windows]
125
+ winget install myapp
126
+ \```
127
+
128
+ :::
129
+ ```
130
+
131
+ ### Progressive Disclosure (For Advanced Content)
132
+
133
+ Hide advanced/optional content behind expandable sections:
134
+
135
+ ```markdown
136
+ <details>
137
+ <summary>Advanced Configuration Options</summary>
138
+
139
+ | Option | Default | Description |
140
+ |--------|---------|-------------|
141
+ | `batch_size` | 32 | Processing batch size |
142
+ | `num_workers` | 4 | Parallel worker count |
143
+
144
+ </details>
145
+ ```
146
+
147
+ ---
148
+
149
+ ## Mermaid Diagram Rules
150
+
151
+ ### Theme-Neutral Approach (No Hardcoded Colors)
152
+
153
+ **CRITICAL:** Do NOT use inline `style` directives in Mermaid diagrams.
154
+
155
+ Hardcoded colors (e.g., `style A fill:#2d333b,color:#e6edf3`) break on light themes.
156
+ VitePress has built-in Mermaid support that auto-adapts to light/dark mode —
157
+ just enable `markdown: { mermaid: true }` in config.
158
+
159
+ **❌ DON'T — Hardcoded dark colors:**
160
+ ```
161
+ style A fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
162
+ ```
163
+
164
+ **✅ DO — Clean, no-style diagrams:**
165
+ ```mermaid
166
+ graph LR
167
+ A[Client] --> B[API]
168
+ B --> C[Database]
169
+ ```
170
+
171
+ > **Note:** Mermaid is built-in to VitePress — no plugin installation needed!
172
+ > Just set `markdown: { mermaid: true }` in `.vitepress/config.mts`.
173
+
174
+ ### Minimum Requirements
175
+
176
+ - **Architecture docs**: ≥ 2 Mermaid diagrams (overview + sequence)
177
+ - **Data flow docs**: ≥ 3 Mermaid diagrams
178
+ - **SOP guides**: ≥ 1 Mermaid flowchart of the process
179
+
180
+ ---
181
+
182
+ ## Writing Style
183
+
184
+ | Rule | ✅ Do | ❌ Don't |
185
+ |------|------| ---------|
186
+ | **Lead with WHY** | "Use streaming for real-time apps" | "The streaming module provides..." |
187
+ | **Active voice** | "Install the package" | "The package should be installed" |
188
+ | **Concrete examples** | "Set `batch_size=64` for GPUs with ≥8GB VRAM" | "Adjust batch size as needed" |
189
+ | **Cite sources** | `(src/engine.py:42)` | "In the engine file" |
190
+ | **Tables > paragraphs** | Use tables for comparisons | Write long comparison paragraphs |
@@ -0,0 +1,184 @@
1
+ # SOP User Guide Generator — UX Master Edition
2
+
3
+ Generate professional Standard Operating Procedure (SOP) user guides with progressive disclosure, visual hierarchy, and multi-platform support.
4
+
5
+ ## Input Required
6
+
7
+ - `docs/_analysis.md` (output from analyze-codebase)
8
+ - Access to source code (routes, UI components, views)
9
+
10
+ ## Content Guidelines
11
+
12
+ **Before generating, read `skills/content-guidelines.md` for:**
13
+ - Progressive disclosure patterns
14
+ - Writing style rules
15
+
16
+ ## Procedure
17
+
18
+ ### 1. Identify User-Facing Features
19
+
20
+ Scan the codebase for:
21
+ - Frontend routes/pages (Next.js pages, React routes, view templates)
22
+ - UI components that represent features
23
+ - API endpoints that correspond to user actions
24
+ - Role-based access (admin, user, operator)
25
+
26
+ ### 2. Group by Module (Miller's Law: 5-9 items per group)
27
+
28
+ Organize features into logical modules:
29
+ ```
30
+ Module: User Management (4 features)
31
+ ├── Login / Register
32
+ ├── Account Settings
33
+ ├── Role Assignment
34
+ └── Password Reset
35
+ ```
36
+
37
+ ### 3. Generate SOP per Feature
38
+
39
+ Output to `docs/sop/[module-name].md`
40
+
41
+ ## SOP Template
42
+
43
+ Each SOP file MUST follow this structure:
44
+
45
+ ```markdown
46
+ ---
47
+ title: "[Feature Name]"
48
+ description: "User guide for [feature name]"
49
+ ---
50
+
51
+ # [Feature Name]
52
+
53
+ > **Quick Reference**
54
+ > - **Who**: [Role required — Admin / User / Operator]
55
+ > - **Where**: [Menu > Submenu > Page]
56
+ > - **Time**: ~[estimated minutes] to complete
57
+ > - **Prerequisites**: [Brief list]
58
+
59
+ ## Prerequisites
60
+
61
+ - [ ] Logged in with role **[role]**
62
+ - [ ] Have [prerequisites]
63
+
64
+ ## Step-by-Step Guide
65
+
66
+ ### Step 1: [Step Name]
67
+
68
+ 1. Navigate to **[Menu] → [Submenu]**
69
+ 2. Click the **[Button Name]** button
70
+ 3. Fill in the information:
71
+
72
+ | Field | Required | Description | Example |
73
+ |-------|----------|-------------|---------|
74
+ | Name | ✅ | Full Name | Jane Doe |
75
+
76
+ 4. Click **Save** to complete
77
+
78
+ <!-- Screenshot: [Description of screenshot to take] -->
79
+
80
+ :::tip
81
+ [Helpful tip for this step — derived from common user behavior]
82
+ :::
83
+
84
+ ### Step 2: [Step Name]
85
+ [Continue...]
86
+
87
+ ## Expected Results
88
+
89
+ - ✅ [Result 1]
90
+ - ✅ [Result 2]
91
+
92
+ ## Troubleshooting
93
+
94
+ <details>
95
+ <summary>🔴 Error: [Error Message 1]</summary>
96
+
97
+ **Cause:** [Root cause]
98
+
99
+ **Solution:**
100
+ 1. [Step to fix]
101
+ 2. [Step to fix]
102
+
103
+ **Source:** `(file_path:line_number)`
104
+
105
+ </details>
106
+
107
+ <details>
108
+ <summary>🔴 Error: [Error Message 2]</summary>
109
+
110
+ **Cause:** [Root cause]
111
+
112
+ **Solution:**
113
+ 1. [Step to fix]
114
+
115
+ </details>
116
+
117
+ ## FAQ
118
+
119
+ <details>
120
+ <summary>Q: [Question 1]?</summary>
121
+
122
+ **A:** [Answer derived from actual code logic]
123
+
124
+ </details>
125
+
126
+ <details>
127
+ <summary>Q: [Question 2]?</summary>
128
+
129
+ **A:** [Answer]
130
+
131
+ </details>
132
+
133
+ ## Related
134
+
135
+ - [Related SOP](./related-module.md)
136
+ - API: `[METHOD] /api/endpoint`
137
+ ```
138
+
139
+ ## Index File
140
+
141
+ Generate `docs/sop/index.md`:
142
+
143
+ ```markdown
144
+ ---
145
+ title: "User Guides"
146
+ description: "System user guides overview"
147
+ ---
148
+
149
+ # User Guides
150
+
151
+ > **Quick Reference**
152
+ > - **Total Features**: [count]
153
+ > - **Roles**: Admin, User, Operator
154
+ > - **Last Updated**: [date]
155
+
156
+ ## Feature Map
157
+
158
+ ```mermaid
159
+ graph TB
160
+ M1["User Management"] --> F1["Login"]
161
+ M1 --> F2["Register"]
162
+ M1 --> F3["Settings"]
163
+ ```
164
+
165
+ ## Feature List
166
+
167
+ | No. | Feature | Description | Role | Difficulty |
168
+ |-----|---------|-------------|------|------------|
169
+ | 1 | [Name] | [Description] | [Role] | 🟢 Easy |
170
+ ```
171
+
172
+ ## Rules
173
+
174
+ - **Quick Reference card** at top of every SOP
175
+ - **Number every step** — users must be able to follow exactly
176
+ - **Include form field tables** with real examples
177
+ - **Use `<details>` for Troubleshooting & FAQ** (Progressive Disclosure — Hick's Law)
178
+ - **Use `:::tip`** for helpful hints within steps
179
+ - **Add `<!-- Screenshot: ... -->` placeholders** where visual guidance helps
180
+ - **Link to related SOPs** and API docs
181
+ - **Keep language simple and direct** — assume non-technical users
182
+ - **Derive FAQ from actual validation rules** and business logic in code
183
+ - **Cite source**: `(file_path:line_number)` for technical accuracy
184
+ - **Estimate time** for each guide in the Quick Reference