autodoc-agent-kit 1.0.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 (187) hide show
  1. package/README.md +362 -0
  2. package/package.json +49 -0
  3. package/src/core/module.yaml +5 -0
  4. package/src/modules/design/module.yaml +9 -0
  5. package/src/modules/design/skills/brand-guidelines/LICENSE.txt +202 -0
  6. package/src/modules/design/skills/brand-guidelines/SKILL.md +73 -0
  7. package/src/modules/design/skills/frontend-design/LICENSE.txt +177 -0
  8. package/src/modules/design/skills/frontend-design/SKILL.md +42 -0
  9. package/src/modules/design/skills/web-artifacts-builder/SKILL.md +229 -0
  10. package/src/modules/devops/module.yaml +10 -0
  11. package/src/modules/devops/skills/devops-helper/SKILL.md +60 -0
  12. package/src/modules/devops/skills/k8s-helm/SKILL.md +360 -0
  13. package/src/modules/devops/skills/monitoring-observability/SKILL.md +240 -0
  14. package/src/modules/devops/skills/security-auditor/SKILL.md +105 -0
  15. package/src/modules/engineering/module.yaml +22 -0
  16. package/src/modules/engineering/skills/ai-sdk/SKILL.md +314 -0
  17. package/src/modules/engineering/skills/api-designer/SKILL.md +77 -0
  18. package/src/modules/engineering/skills/code-reviewer/SKILL.md +71 -0
  19. package/src/modules/engineering/skills/db-architect/SKILL.md +50 -0
  20. package/src/modules/engineering/skills/debugger/SKILL.md +59 -0
  21. package/src/modules/engineering/skills/docs-generator/SKILL.md +51 -0
  22. package/src/modules/engineering/skills/git-workflow/SKILL.md +258 -0
  23. package/src/modules/engineering/skills/mcp-builder/LICENSE.txt +202 -0
  24. package/src/modules/engineering/skills/mcp-builder/SKILL.md +236 -0
  25. package/src/modules/engineering/skills/mcp-builder/reference/evaluation.md +602 -0
  26. package/src/modules/engineering/skills/mcp-builder/reference/mcp_best_practices.md +249 -0
  27. package/src/modules/engineering/skills/mcp-builder/reference/node_mcp_server.md +970 -0
  28. package/src/modules/engineering/skills/mcp-builder/reference/python_mcp_server.md +719 -0
  29. package/src/modules/engineering/skills/mcp-builder/scripts/connections.py +151 -0
  30. package/src/modules/engineering/skills/mcp-builder/scripts/evaluation.py +373 -0
  31. package/src/modules/engineering/skills/mcp-builder/scripts/example_evaluation.xml +22 -0
  32. package/src/modules/engineering/skills/mcp-builder/scripts/requirements.txt +2 -0
  33. package/src/modules/engineering/skills/nextjs-15/SKILL.md +312 -0
  34. package/src/modules/engineering/skills/perf-optimizer/SKILL.md +60 -0
  35. package/src/modules/engineering/skills/react-19/SKILL.md +257 -0
  36. package/src/modules/engineering/skills/refactorer/SKILL.md +60 -0
  37. package/src/modules/engineering/skills/skill-authoring-workflow/SKILL.md +183 -0
  38. package/src/modules/engineering/skills/skill-creator/LICENSE.txt +202 -0
  39. package/src/modules/engineering/skills/skill-creator/SKILL.md +356 -0
  40. package/src/modules/engineering/skills/skill-creator/references/output-patterns.md +82 -0
  41. package/src/modules/engineering/skills/skill-creator/references/workflows.md +28 -0
  42. package/src/modules/engineering/skills/skill-creator/scripts/__pycache__/quick_validate.cpython-313.pyc +0 -0
  43. package/src/modules/engineering/skills/skill-creator/scripts/init_skill.py +303 -0
  44. package/src/modules/engineering/skills/skill-creator/scripts/package_skill.py +110 -0
  45. package/src/modules/engineering/skills/skill-creator/scripts/quick_validate.py +95 -0
  46. package/src/modules/engineering/skills/typescript/SKILL.md +231 -0
  47. package/src/modules/engineering/skills/zod-4/SKILL.md +223 -0
  48. package/src/modules/product/module.yaml +51 -0
  49. package/src/modules/product/skills/acquisition-channel-advisor/SKILL.md +643 -0
  50. package/src/modules/product/skills/acquisition-channel-advisor/examples/conversation-flow.md +531 -0
  51. package/src/modules/product/skills/ai-shaped-readiness-advisor/SKILL.md +923 -0
  52. package/src/modules/product/skills/altitude-horizon-framework/SKILL.md +250 -0
  53. package/src/modules/product/skills/altitude-horizon-framework/examples/sample.md +85 -0
  54. package/src/modules/product/skills/business-health-diagnostic/SKILL.md +783 -0
  55. package/src/modules/product/skills/company-research/SKILL.md +385 -0
  56. package/src/modules/product/skills/company-research/examples/sample.md +164 -0
  57. package/src/modules/product/skills/company-research/template.md +60 -0
  58. package/src/modules/product/skills/context-engineering-advisor/SKILL.md +763 -0
  59. package/src/modules/product/skills/customer-journey-map/SKILL.md +346 -0
  60. package/src/modules/product/skills/customer-journey-map/examples/meta-product-manager-skills.md +40 -0
  61. package/src/modules/product/skills/customer-journey-map/examples/sample.md +33 -0
  62. package/src/modules/product/skills/customer-journey-map/template.md +28 -0
  63. package/src/modules/product/skills/customer-journey-mapping-workshop/SKILL.md +523 -0
  64. package/src/modules/product/skills/director-readiness-advisor/SKILL.md +351 -0
  65. package/src/modules/product/skills/director-readiness-advisor/examples/conversation-flow.md +96 -0
  66. package/src/modules/product/skills/discovery-interview-prep/SKILL.md +410 -0
  67. package/src/modules/product/skills/discovery-process/SKILL.md +504 -0
  68. package/src/modules/product/skills/discovery-process/examples/sample.md +60 -0
  69. package/src/modules/product/skills/discovery-process/template.md +39 -0
  70. package/src/modules/product/skills/eol-message/SKILL.md +348 -0
  71. package/src/modules/product/skills/eol-message/examples/sample.md +87 -0
  72. package/src/modules/product/skills/eol-message/template.md +74 -0
  73. package/src/modules/product/skills/epic-breakdown-advisor/SKILL.md +665 -0
  74. package/src/modules/product/skills/epic-hypothesis/SKILL.md +277 -0
  75. package/src/modules/product/skills/epic-hypothesis/examples/sample.md +104 -0
  76. package/src/modules/product/skills/epic-hypothesis/template.md +30 -0
  77. package/src/modules/product/skills/executive-onboarding-playbook/SKILL.md +280 -0
  78. package/src/modules/product/skills/executive-onboarding-playbook/examples/sample.md +116 -0
  79. package/src/modules/product/skills/feature-investment-advisor/SKILL.md +639 -0
  80. package/src/modules/product/skills/feature-investment-advisor/examples/conversation-flow.md +538 -0
  81. package/src/modules/product/skills/finance-based-pricing-advisor/SKILL.md +763 -0
  82. package/src/modules/product/skills/finance-metrics-quickref/SKILL.md +309 -0
  83. package/src/modules/product/skills/jobs-to-be-done/SKILL.md +370 -0
  84. package/src/modules/product/skills/jobs-to-be-done/examples/sample.md +80 -0
  85. package/src/modules/product/skills/jobs-to-be-done/template.md +65 -0
  86. package/src/modules/product/skills/lean-ux-canvas/SKILL.md +561 -0
  87. package/src/modules/product/skills/lean-ux-canvas/examples/sample.md +88 -0
  88. package/src/modules/product/skills/lean-ux-canvas/template.md +32 -0
  89. package/src/modules/product/skills/opportunity-solution-tree/SKILL.md +420 -0
  90. package/src/modules/product/skills/opportunity-solution-tree/examples/sample.md +104 -0
  91. package/src/modules/product/skills/opportunity-solution-tree/template.md +33 -0
  92. package/src/modules/product/skills/pestel-analysis/SKILL.md +376 -0
  93. package/src/modules/product/skills/pestel-analysis/examples/sample.md +143 -0
  94. package/src/modules/product/skills/pestel-analysis/template.md +53 -0
  95. package/src/modules/product/skills/pol-probe/SKILL.md +217 -0
  96. package/src/modules/product/skills/pol-probe/examples/sample.md +136 -0
  97. package/src/modules/product/skills/pol-probe/template.md +59 -0
  98. package/src/modules/product/skills/pol-probe-advisor/SKILL.md +492 -0
  99. package/src/modules/product/skills/positioning-statement/SKILL.md +230 -0
  100. package/src/modules/product/skills/positioning-statement/examples/sample.md +51 -0
  101. package/src/modules/product/skills/positioning-statement/template.md +25 -0
  102. package/src/modules/product/skills/positioning-workshop/SKILL.md +424 -0
  103. package/src/modules/product/skills/prd-development/SKILL.md +655 -0
  104. package/src/modules/product/skills/prd-development/examples/sample.md +43 -0
  105. package/src/modules/product/skills/prd-development/template.md +55 -0
  106. package/src/modules/product/skills/press-release/SKILL.md +269 -0
  107. package/src/modules/product/skills/press-release/examples/sample.md +73 -0
  108. package/src/modules/product/skills/press-release/template.md +39 -0
  109. package/src/modules/product/skills/prioritization-advisor/SKILL.md +448 -0
  110. package/src/modules/product/skills/problem-framing-canvas/SKILL.md +466 -0
  111. package/src/modules/product/skills/problem-framing-canvas/examples/sample.md +58 -0
  112. package/src/modules/product/skills/problem-framing-canvas/template.md +22 -0
  113. package/src/modules/product/skills/problem-statement/SKILL.md +246 -0
  114. package/src/modules/product/skills/problem-statement/examples/sample.md +82 -0
  115. package/src/modules/product/skills/problem-statement/template.md +37 -0
  116. package/src/modules/product/skills/product-strategy-session/SKILL.md +426 -0
  117. package/src/modules/product/skills/product-strategy-session/examples/sample.md +67 -0
  118. package/src/modules/product/skills/product-strategy-session/template.md +38 -0
  119. package/src/modules/product/skills/proto-persona/SKILL.md +326 -0
  120. package/src/modules/product/skills/proto-persona/examples/sample.md +97 -0
  121. package/src/modules/product/skills/proto-persona/template.md +45 -0
  122. package/src/modules/product/skills/recommendation-canvas/SKILL.md +375 -0
  123. package/src/modules/product/skills/recommendation-canvas/examples/sample.md +94 -0
  124. package/src/modules/product/skills/recommendation-canvas/template.md +86 -0
  125. package/src/modules/product/skills/roadmap-planning/SKILL.md +505 -0
  126. package/src/modules/product/skills/roadmap-planning/examples/sample.md +62 -0
  127. package/src/modules/product/skills/roadmap-planning/template.md +30 -0
  128. package/src/modules/product/skills/saas-economics-efficiency-metrics/SKILL.md +694 -0
  129. package/src/modules/product/skills/saas-economics-efficiency-metrics/examples/cash-trap.md +365 -0
  130. package/src/modules/product/skills/saas-economics-efficiency-metrics/examples/healthy-unit-economics.md +279 -0
  131. package/src/modules/product/skills/saas-economics-efficiency-metrics/template.md +263 -0
  132. package/src/modules/product/skills/saas-revenue-growth-metrics/SKILL.md +630 -0
  133. package/src/modules/product/skills/saas-revenue-growth-metrics/examples/healthy-saas.md +131 -0
  134. package/src/modules/product/skills/saas-revenue-growth-metrics/examples/warning-signs.md +229 -0
  135. package/src/modules/product/skills/saas-revenue-growth-metrics/template.md +192 -0
  136. package/src/modules/product/skills/storyboard/SKILL.md +252 -0
  137. package/src/modules/product/skills/storyboard/examples/sample.md +71 -0
  138. package/src/modules/product/skills/storyboard/template.md +41 -0
  139. package/src/modules/product/skills/tam-sam-som-calculator/SKILL.md +392 -0
  140. package/src/modules/product/skills/tam-sam-som-calculator/examples/sample.md +142 -0
  141. package/src/modules/product/skills/tam-sam-som-calculator/scripts/market-sizing.py +95 -0
  142. package/src/modules/product/skills/tam-sam-som-calculator/template.md +35 -0
  143. package/src/modules/product/skills/user-story/SKILL.md +272 -0
  144. package/src/modules/product/skills/user-story/examples/sample.md +110 -0
  145. package/src/modules/product/skills/user-story/scripts/user-story-template.py +65 -0
  146. package/src/modules/product/skills/user-story/template.md +32 -0
  147. package/src/modules/product/skills/user-story-mapping/SKILL.md +285 -0
  148. package/src/modules/product/skills/user-story-mapping/examples/sample.md +77 -0
  149. package/src/modules/product/skills/user-story-mapping/template.md +41 -0
  150. package/src/modules/product/skills/user-story-mapping-workshop/SKILL.md +477 -0
  151. package/src/modules/product/skills/user-story-mapping-workshop/template.md +28 -0
  152. package/src/modules/product/skills/user-story-splitting/SKILL.md +303 -0
  153. package/src/modules/product/skills/user-story-splitting/examples/sample.md +147 -0
  154. package/src/modules/product/skills/user-story-splitting/template.md +37 -0
  155. package/src/modules/product/skills/vp-cpo-readiness-advisor/SKILL.md +409 -0
  156. package/src/modules/product/skills/vp-cpo-readiness-advisor/examples/conversation-flow.md +95 -0
  157. package/src/modules/product/skills/workshop-facilitation/SKILL.md +87 -0
  158. package/src/modules/productivity/module.yaml +9 -0
  159. package/src/modules/productivity/skills/doc-coauthoring/SKILL.md +375 -0
  160. package/src/modules/productivity/skills/internal-comms/LICENSE.txt +202 -0
  161. package/src/modules/productivity/skills/internal-comms/SKILL.md +32 -0
  162. package/src/modules/productivity/skills/internal-comms/examples/3p-updates.md +47 -0
  163. package/src/modules/productivity/skills/internal-comms/examples/company-newsletter.md +65 -0
  164. package/src/modules/productivity/skills/internal-comms/examples/faq-answers.md +30 -0
  165. package/src/modules/productivity/skills/internal-comms/examples/general-comms.md +16 -0
  166. package/src/modules/productivity/skills/technical-writing/SKILL.md +266 -0
  167. package/src/modules/qa/module.yaml +9 -0
  168. package/src/modules/qa/skills/test-strategy/SKILL.md +263 -0
  169. package/src/modules/qa/skills/test-writer/SKILL.md +57 -0
  170. package/src/modules/qa/skills/webapp-testing/LICENSE.txt +202 -0
  171. package/src/modules/qa/skills/webapp-testing/SKILL.md +96 -0
  172. package/src/modules/qa/skills/webapp-testing/examples/console_logging.py +35 -0
  173. package/src/modules/qa/skills/webapp-testing/examples/element_discovery.py +40 -0
  174. package/src/modules/qa/skills/webapp-testing/examples/static_html_automation.py +33 -0
  175. package/src/modules/qa/skills/webapp-testing/scripts/with_server.py +106 -0
  176. package/tools/autodoc-npx-wrapper.js +34 -0
  177. package/tools/cli/autodoc-cli.js +55 -0
  178. package/tools/cli/commands/install.js +36 -0
  179. package/tools/cli/commands/status.js +35 -0
  180. package/tools/cli/commands/uninstall.js +60 -0
  181. package/tools/cli/installers/lib/core/installer.js +164 -0
  182. package/tools/cli/installers/lib/core/manifest.js +49 -0
  183. package/tools/cli/installers/lib/ide/manager.js +112 -0
  184. package/tools/cli/installers/lib/ide/platform-codes.yaml +207 -0
  185. package/tools/cli/installers/lib/modules/manager.js +59 -0
  186. package/tools/cli/lib/ui.js +199 -0
  187. package/tools/cli/lib/welcome.js +82 -0
@@ -0,0 +1,375 @@
1
+ ---
2
+ name: doc-coauthoring
3
+ description: Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
4
+ ---
5
+
6
+ # Doc Co-Authoring Workflow
7
+
8
+ This skill provides a structured workflow for guiding users through collaborative document creation. Act as an active guide, walking users through three stages: Context Gathering, Refinement & Structure, and Reader Testing.
9
+
10
+ ## When to Offer This Workflow
11
+
12
+ **Trigger conditions:**
13
+ - User mentions writing documentation: "write a doc", "draft a proposal", "create a spec", "write up"
14
+ - User mentions specific doc types: "PRD", "design doc", "decision doc", "RFC"
15
+ - User seems to be starting a substantial writing task
16
+
17
+ **Initial offer:**
18
+ Offer the user a structured workflow for co-authoring the document. Explain the three stages:
19
+
20
+ 1. **Context Gathering**: User provides all relevant context while Claude asks clarifying questions
21
+ 2. **Refinement & Structure**: Iteratively build each section through brainstorming and editing
22
+ 3. **Reader Testing**: Test the doc with a fresh Claude (no context) to catch blind spots before others read it
23
+
24
+ Explain that this approach helps ensure the doc works well when others read it (including when they paste it into Claude). Ask if they want to try this workflow or prefer to work freeform.
25
+
26
+ If user declines, work freeform. If user accepts, proceed to Stage 1.
27
+
28
+ ## Stage 1: Context Gathering
29
+
30
+ **Goal:** Close the gap between what the user knows and what Claude knows, enabling smart guidance later.
31
+
32
+ ### Initial Questions
33
+
34
+ Start by asking the user for meta-context about the document:
35
+
36
+ 1. What type of document is this? (e.g., technical spec, decision doc, proposal)
37
+ 2. Who's the primary audience?
38
+ 3. What's the desired impact when someone reads this?
39
+ 4. Is there a template or specific format to follow?
40
+ 5. Any other constraints or context to know?
41
+
42
+ Inform them they can answer in shorthand or dump information however works best for them.
43
+
44
+ **If user provides a template or mentions a doc type:**
45
+ - Ask if they have a template document to share
46
+ - If they provide a link to a shared document, use the appropriate integration to fetch it
47
+ - If they provide a file, read it
48
+
49
+ **If user mentions editing an existing shared document:**
50
+ - Use the appropriate integration to read the current state
51
+ - Check for images without alt-text
52
+ - If images exist without alt-text, explain that when others use Claude to understand the doc, Claude won't be able to see them. Ask if they want alt-text generated. If so, request they paste each image into chat for descriptive alt-text generation.
53
+
54
+ ### Info Dumping
55
+
56
+ Once initial questions are answered, encourage the user to dump all the context they have. Request information such as:
57
+ - Background on the project/problem
58
+ - Related team discussions or shared documents
59
+ - Why alternative solutions aren't being used
60
+ - Organizational context (team dynamics, past incidents, politics)
61
+ - Timeline pressures or constraints
62
+ - Technical architecture or dependencies
63
+ - Stakeholder concerns
64
+
65
+ Advise them not to worry about organizing it - just get it all out. Offer multiple ways to provide context:
66
+ - Info dump stream-of-consciousness
67
+ - Point to team channels or threads to read
68
+ - Link to shared documents
69
+
70
+ **If integrations are available** (e.g., Slack, Teams, Google Drive, SharePoint, or other MCP servers), mention that these can be used to pull in context directly.
71
+
72
+ **If no integrations are detected and in Claude.ai or Claude app:** Suggest they can enable connectors in their Claude settings to allow pulling context from messaging apps and document storage directly.
73
+
74
+ Inform them clarifying questions will be asked once they've done their initial dump.
75
+
76
+ **During context gathering:**
77
+
78
+ - If user mentions team channels or shared documents:
79
+ - If integrations available: Inform them the content will be read now, then use the appropriate integration
80
+ - If integrations not available: Explain lack of access. Suggest they enable connectors in Claude settings, or paste the relevant content directly.
81
+
82
+ - If user mentions entities/projects that are unknown:
83
+ - Ask if connected tools should be searched to learn more
84
+ - Wait for user confirmation before searching
85
+
86
+ - As user provides context, track what's being learned and what's still unclear
87
+
88
+ **Asking clarifying questions:**
89
+
90
+ When user signals they've done their initial dump (or after substantial context provided), ask clarifying questions to ensure understanding:
91
+
92
+ Generate 5-10 numbered questions based on gaps in the context.
93
+
94
+ Inform them they can use shorthand to answer (e.g., "1: yes, 2: see #channel, 3: no because backwards compat"), link to more docs, point to channels to read, or just keep info-dumping. Whatever's most efficient for them.
95
+
96
+ **Exit condition:**
97
+ Sufficient context has been gathered when questions show understanding - when edge cases and trade-offs can be asked about without needing basics explained.
98
+
99
+ **Transition:**
100
+ Ask if there's any more context they want to provide at this stage, or if it's time to move on to drafting the document.
101
+
102
+ If user wants to add more, let them. When ready, proceed to Stage 2.
103
+
104
+ ## Stage 2: Refinement & Structure
105
+
106
+ **Goal:** Build the document section by section through brainstorming, curation, and iterative refinement.
107
+
108
+ **Instructions to user:**
109
+ Explain that the document will be built section by section. For each section:
110
+ 1. Clarifying questions will be asked about what to include
111
+ 2. 5-20 options will be brainstormed
112
+ 3. User will indicate what to keep/remove/combine
113
+ 4. The section will be drafted
114
+ 5. It will be refined through surgical edits
115
+
116
+ Start with whichever section has the most unknowns (usually the core decision/proposal), then work through the rest.
117
+
118
+ **Section ordering:**
119
+
120
+ If the document structure is clear:
121
+ Ask which section they'd like to start with.
122
+
123
+ Suggest starting with whichever section has the most unknowns. For decision docs, that's usually the core proposal. For specs, it's typically the technical approach. Summary sections are best left for last.
124
+
125
+ If user doesn't know what sections they need:
126
+ Based on the type of document and template, suggest 3-5 sections appropriate for the doc type.
127
+
128
+ Ask if this structure works, or if they want to adjust it.
129
+
130
+ **Once structure is agreed:**
131
+
132
+ Create the initial document structure with placeholder text for all sections.
133
+
134
+ **If access to artifacts is available:**
135
+ Use `create_file` to create an artifact. This gives both Claude and the user a scaffold to work from.
136
+
137
+ Inform them that the initial structure with placeholders for all sections will be created.
138
+
139
+ Create artifact with all section headers and brief placeholder text like "[To be written]" or "[Content here]".
140
+
141
+ Provide the scaffold link and indicate it's time to fill in each section.
142
+
143
+ **If no access to artifacts:**
144
+ Create a markdown file in the working directory. Name it appropriately (e.g., `decision-doc.md`, `technical-spec.md`).
145
+
146
+ Inform them that the initial structure with placeholders for all sections will be created.
147
+
148
+ Create file with all section headers and placeholder text.
149
+
150
+ Confirm the filename has been created and indicate it's time to fill in each section.
151
+
152
+ **For each section:**
153
+
154
+ ### Step 1: Clarifying Questions
155
+
156
+ Announce work will begin on the [SECTION NAME] section. Ask 5-10 clarifying questions about what should be included:
157
+
158
+ Generate 5-10 specific questions based on context and section purpose.
159
+
160
+ Inform them they can answer in shorthand or just indicate what's important to cover.
161
+
162
+ ### Step 2: Brainstorming
163
+
164
+ For the [SECTION NAME] section, brainstorm [5-20] things that might be included, depending on the section's complexity. Look for:
165
+ - Context shared that might have been forgotten
166
+ - Angles or considerations not yet mentioned
167
+
168
+ Generate 5-20 numbered options based on section complexity. At the end, offer to brainstorm more if they want additional options.
169
+
170
+ ### Step 3: Curation
171
+
172
+ Ask which points should be kept, removed, or combined. Request brief justifications to help learn priorities for the next sections.
173
+
174
+ Provide examples:
175
+ - "Keep 1,4,7,9"
176
+ - "Remove 3 (duplicates 1)"
177
+ - "Remove 6 (audience already knows this)"
178
+ - "Combine 11 and 12"
179
+
180
+ **If user gives freeform feedback** (e.g., "looks good" or "I like most of it but...") instead of numbered selections, extract their preferences and proceed. Parse what they want kept/removed/changed and apply it.
181
+
182
+ ### Step 4: Gap Check
183
+
184
+ Based on what they've selected, ask if there's anything important missing for the [SECTION NAME] section.
185
+
186
+ ### Step 5: Drafting
187
+
188
+ Use `str_replace` to replace the placeholder text for this section with the actual drafted content.
189
+
190
+ Announce the [SECTION NAME] section will be drafted now based on what they've selected.
191
+
192
+ **If using artifacts:**
193
+ After drafting, provide a link to the artifact.
194
+
195
+ Ask them to read through it and indicate what to change. Note that being specific helps learning for the next sections.
196
+
197
+ **If using a file (no artifacts):**
198
+ After drafting, confirm completion.
199
+
200
+ Inform them the [SECTION NAME] section has been drafted in [filename]. Ask them to read through it and indicate what to change. Note that being specific helps learning for the next sections.
201
+
202
+ **Key instruction for user (include when drafting the first section):**
203
+ Provide a note: Instead of editing the doc directly, ask them to indicate what to change. This helps learning of their style for future sections. For example: "Remove the X bullet - already covered by Y" or "Make the third paragraph more concise".
204
+
205
+ ### Step 6: Iterative Refinement
206
+
207
+ As user provides feedback:
208
+ - Use `str_replace` to make edits (never reprint the whole doc)
209
+ - **If using artifacts:** Provide link to artifact after each edit
210
+ - **If using files:** Just confirm edits are complete
211
+ - If user edits doc directly and asks to read it: mentally note the changes they made and keep them in mind for future sections (this shows their preferences)
212
+
213
+ **Continue iterating** until user is satisfied with the section.
214
+
215
+ ### Quality Checking
216
+
217
+ After 3 consecutive iterations with no substantial changes, ask if anything can be removed without losing important information.
218
+
219
+ When section is done, confirm [SECTION NAME] is complete. Ask if ready to move to the next section.
220
+
221
+ **Repeat for all sections.**
222
+
223
+ ### Near Completion
224
+
225
+ As approaching completion (80%+ of sections done), announce intention to re-read the entire document and check for:
226
+ - Flow and consistency across sections
227
+ - Redundancy or contradictions
228
+ - Anything that feels like "slop" or generic filler
229
+ - Whether every sentence carries weight
230
+
231
+ Read entire document and provide feedback.
232
+
233
+ **When all sections are drafted and refined:**
234
+ Announce all sections are drafted. Indicate intention to review the complete document one more time.
235
+
236
+ Review for overall coherence, flow, completeness.
237
+
238
+ Provide any final suggestions.
239
+
240
+ Ask if ready to move to Reader Testing, or if they want to refine anything else.
241
+
242
+ ## Stage 3: Reader Testing
243
+
244
+ **Goal:** Test the document with a fresh Claude (no context bleed) to verify it works for readers.
245
+
246
+ **Instructions to user:**
247
+ Explain that testing will now occur to see if the document actually works for readers. This catches blind spots - things that make sense to the authors but might confuse others.
248
+
249
+ ### Testing Approach
250
+
251
+ **If access to sub-agents is available (e.g., in Claude Code):**
252
+
253
+ Perform the testing directly without user involvement.
254
+
255
+ ### Step 1: Predict Reader Questions
256
+
257
+ Announce intention to predict what questions readers might ask when trying to discover this document.
258
+
259
+ Generate 5-10 questions that readers would realistically ask.
260
+
261
+ ### Step 2: Test with Sub-Agent
262
+
263
+ Announce that these questions will be tested with a fresh Claude instance (no context from this conversation).
264
+
265
+ For each question, invoke a sub-agent with just the document content and the question.
266
+
267
+ Summarize what Reader Claude got right/wrong for each question.
268
+
269
+ ### Step 3: Run Additional Checks
270
+
271
+ Announce additional checks will be performed.
272
+
273
+ Invoke sub-agent to check for ambiguity, false assumptions, contradictions.
274
+
275
+ Summarize any issues found.
276
+
277
+ ### Step 4: Report and Fix
278
+
279
+ If issues found:
280
+ Report that Reader Claude struggled with specific issues.
281
+
282
+ List the specific issues.
283
+
284
+ Indicate intention to fix these gaps.
285
+
286
+ Loop back to refinement for problematic sections.
287
+
288
+ ---
289
+
290
+ **If no access to sub-agents (e.g., claude.ai web interface):**
291
+
292
+ The user will need to do the testing manually.
293
+
294
+ ### Step 1: Predict Reader Questions
295
+
296
+ Ask what questions people might ask when trying to discover this document. What would they type into Claude.ai?
297
+
298
+ Generate 5-10 questions that readers would realistically ask.
299
+
300
+ ### Step 2: Setup Testing
301
+
302
+ Provide testing instructions:
303
+ 1. Open a fresh Claude conversation: https://claude.ai
304
+ 2. Paste or share the document content (if using a shared doc platform with connectors enabled, provide the link)
305
+ 3. Ask Reader Claude the generated questions
306
+
307
+ For each question, instruct Reader Claude to provide:
308
+ - The answer
309
+ - Whether anything was ambiguous or unclear
310
+ - What knowledge/context the doc assumes is already known
311
+
312
+ Check if Reader Claude gives correct answers or misinterprets anything.
313
+
314
+ ### Step 3: Additional Checks
315
+
316
+ Also ask Reader Claude:
317
+ - "What in this doc might be ambiguous or unclear to readers?"
318
+ - "What knowledge or context does this doc assume readers already have?"
319
+ - "Are there any internal contradictions or inconsistencies?"
320
+
321
+ ### Step 4: Iterate Based on Results
322
+
323
+ Ask what Reader Claude got wrong or struggled with. Indicate intention to fix those gaps.
324
+
325
+ Loop back to refinement for any problematic sections.
326
+
327
+ ---
328
+
329
+ ### Exit Condition (Both Approaches)
330
+
331
+ When Reader Claude consistently answers questions correctly and doesn't surface new gaps or ambiguities, the doc is ready.
332
+
333
+ ## Final Review
334
+
335
+ When Reader Testing passes:
336
+ Announce the doc has passed Reader Claude testing. Before completion:
337
+
338
+ 1. Recommend they do a final read-through themselves - they own this document and are responsible for its quality
339
+ 2. Suggest double-checking any facts, links, or technical details
340
+ 3. Ask them to verify it achieves the impact they wanted
341
+
342
+ Ask if they want one more review, or if the work is done.
343
+
344
+ **If user wants final review, provide it. Otherwise:**
345
+ Announce document completion. Provide a few final tips:
346
+ - Consider linking this conversation in an appendix so readers can see how the doc was developed
347
+ - Use appendices to provide depth without bloating the main doc
348
+ - Update the doc as feedback is received from real readers
349
+
350
+ ## Tips for Effective Guidance
351
+
352
+ **Tone:**
353
+ - Be direct and procedural
354
+ - Explain rationale briefly when it affects user behavior
355
+ - Don't try to "sell" the approach - just execute it
356
+
357
+ **Handling Deviations:**
358
+ - If user wants to skip a stage: Ask if they want to skip this and write freeform
359
+ - If user seems frustrated: Acknowledge this is taking longer than expected. Suggest ways to move faster
360
+ - Always give user agency to adjust the process
361
+
362
+ **Context Management:**
363
+ - Throughout, if context is missing on something mentioned, proactively ask
364
+ - Don't let gaps accumulate - address them as they come up
365
+
366
+ **Artifact Management:**
367
+ - Use `create_file` for drafting full sections
368
+ - Use `str_replace` for all edits
369
+ - Provide artifact link after every change
370
+ - Never use artifacts for brainstorming lists - that's just conversation
371
+
372
+ **Quality over Speed:**
373
+ - Don't rush through stages
374
+ - Each iteration should make meaningful improvements
375
+ - The goal is a document that actually works for readers
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,32 @@
1
+ ---
2
+ name: internal-comms
3
+ description: A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).
4
+ license: Complete terms in LICENSE.txt
5
+ ---
6
+
7
+ ## When to use this skill
8
+ To write internal communications, use this skill for:
9
+ - 3P updates (Progress, Plans, Problems)
10
+ - Company newsletters
11
+ - FAQ responses
12
+ - Status reports
13
+ - Leadership updates
14
+ - Project updates
15
+ - Incident reports
16
+
17
+ ## How to use this skill
18
+
19
+ To write any internal communication:
20
+
21
+ 1. **Identify the communication type** from the request
22
+ 2. **Load the appropriate guideline file** from the `examples/` directory:
23
+ - `examples/3p-updates.md` - For Progress/Plans/Problems team updates
24
+ - `examples/company-newsletter.md` - For company-wide newsletters
25
+ - `examples/faq-answers.md` - For answering frequently asked questions
26
+ - `examples/general-comms.md` - For anything else that doesn't explicitly match one of the above
27
+ 3. **Follow the specific instructions** in that file for formatting, tone, and content gathering
28
+
29
+ If the communication type doesn't match any existing guideline, ask for clarification or more context about the desired format.
30
+
31
+ ## Keywords
32
+ 3P updates, company newsletter, company comms, weekly update, faqs, common questions, updates, internal comms
@@ -0,0 +1,47 @@
1
+ ## Instructions
2
+ You are being asked to write a 3P update. 3P updates stand for "Progress, Plans, Problems." The main audience is for executives, leadership, other teammates, etc. They're meant to be very succinct and to-the-point: think something you can read in 30-60sec or less. They're also for people with some, but not a lot of context on what the team does.
3
+
4
+ 3Ps can cover a team of any size, ranging all the way up to the entire company. The bigger the team, the less granular the tasks should be. For example, "mobile team" might have "shipped feature" or "fixed bugs," whereas the company might have really meaty 3Ps, like "hired 20 new people" or "closed 10 new deals."
5
+
6
+ They represent the work of the team across a time period, almost always one week. They include three sections:
7
+ 1) Progress: what the team has accomplished over the next time period. Focus mainly on things shipped, milestones achieved, tasks created, etc.
8
+ 2) Plans: what the team plans to do over the next time period. Focus on what things are top-of-mind, really high priority, etc. for the team.
9
+ 3) Problems: anything that is slowing the team down. This could be things like too few people, bugs or blockers that are preventing the team from moving forward, some deal that fell through, etc.
10
+
11
+ Before writing them, make sure that you know the team name. If it's not specified, you can ask explicitly what the team name you're writing for is.
12
+
13
+
14
+ ## Tools Available
15
+ Whenever possible, try to pull from available sources to get the information you need:
16
+ - Slack: posts from team members with their updates - ideally look for posts in large channels with lots of reactions
17
+ - Google Drive: docs written from critical team members with lots of views
18
+ - Email: emails with lots of responses of lots of content that seems relevant
19
+ - Calendar: non-recurring meetings that have a lot of importance, like product reviews, etc.
20
+
21
+
22
+ Try to gather as much context as you can, focusing on the things that covered the time period you're writing for:
23
+ - Progress: anything between a week ago and today
24
+ - Plans: anything from today to the next week
25
+ - Problems: anything between a week ago and today
26
+
27
+
28
+ If you don't have access, you can ask the user for things they want to cover. They might also include these things to you directly, in which case you're mostly just formatting for this particular format.
29
+
30
+ ## Workflow
31
+
32
+ 1. **Clarify scope**: Confirm the team name and time period (usually past week for Progress/Problems, next
33
+ week for Plans)
34
+ 2. **Gather information**: Use available tools or ask the user directly
35
+ 3. **Draft the update**: Follow the strict formatting guidelines
36
+ 4. **Review**: Ensure it's concise (30-60 seconds to read) and data-driven
37
+
38
+ ## Formatting
39
+
40
+ The format is always the same, very strict formatting. Never use any formatting other than this. Pick an emoji that is fun and captures the vibe of the team and update.
41
+
42
+ [pick an emoji] [Team Name] (Dates Covered, usually a week)
43
+ Progress: [1-3 sentences of content]
44
+ Plans: [1-3 sentences of content]
45
+ Problems: [1-3 sentences of content]
46
+
47
+ Each section should be no more than 1-3 sentences: clear, to the point. It should be data-driven, and generally include metrics where possible. The tone should be very matter-of-fact, not super prose-heavy.