@tgoodington/intuition 8.1.2 → 9.2.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 (116) hide show
  1. package/docs/v9/decision-framework-direction.md +142 -0
  2. package/docs/v9/decision-framework-implementation.md +114 -0
  3. package/docs/v9/domain-adaptive-team-architecture.md +1016 -0
  4. package/docs/v9/test/SESSION_SUMMARY.md +117 -0
  5. package/docs/v9/test/TEST_PLAN.md +119 -0
  6. package/docs/v9/test/blueprints/legal-analyst.md +166 -0
  7. package/docs/v9/test/output/07_cover_letter.md +41 -0
  8. package/docs/v9/test/phase2/mock_plan.md +89 -0
  9. package/docs/v9/test/phase2/producers.json +32 -0
  10. package/docs/v9/test/phase2/specialists/database-architect.specialist.md +10 -0
  11. package/docs/v9/test/phase2/specialists/financial-analyst.specialist.md +10 -0
  12. package/docs/v9/test/phase2/specialists/legal-analyst.specialist.md +10 -0
  13. package/docs/v9/test/phase2/specialists/technical-writer.specialist.md +10 -0
  14. package/docs/v9/test/phase2/team_assignment.json +61 -0
  15. package/docs/v9/test/phase3/blueprints/legal-analyst.md +840 -0
  16. package/docs/v9/test/phase3/legal-analyst-full.specialist.md +111 -0
  17. package/docs/v9/test/phase3/project_context/nh_landlord_tenant_notes.md +35 -0
  18. package/docs/v9/test/phase3/project_context/property_facts.md +32 -0
  19. package/docs/v9/test/phase3b/blueprints/legal-analyst.md +1715 -0
  20. package/docs/v9/test/phase3b/legal-analyst.specialist.md +153 -0
  21. package/docs/v9/test/phase3b/scratch/legal-analyst-stage1.md +270 -0
  22. package/docs/v9/test/phase4/TEST_PLAN.md +32 -0
  23. package/docs/v9/test/phase4/blueprints/financial-analyst-T2.md +538 -0
  24. package/docs/v9/test/phase4/blueprints/legal-analyst-T4.md +253 -0
  25. package/docs/v9/test/phase4/cross-blueprint-check.md +280 -0
  26. package/docs/v9/test/phase4/scratch/financial-analyst-T2-stage1.md +67 -0
  27. package/docs/v9/test/phase4/scratch/legal-analyst-T4-stage1.md +54 -0
  28. package/docs/v9/test/phase4/specialists/financial-analyst.specialist.md +156 -0
  29. package/docs/v9/test/phase4/specialists/legal-analyst.specialist.md +153 -0
  30. package/docs/v9/test/phase5/TEST_PLAN.md +35 -0
  31. package/docs/v9/test/phase5/blueprints/code-architect-hw-vetter.md +375 -0
  32. package/docs/v9/test/phase5/output/04_compliance_checklist.md +149 -0
  33. package/docs/v9/test/phase5/output/hardware-vetter-SKILL-v2.md +561 -0
  34. package/docs/v9/test/phase5/output/hardware-vetter-SKILL.md +459 -0
  35. package/docs/v9/test/phase5/producers/code-writer.producer.md +49 -0
  36. package/docs/v9/test/phase5/producers/document-writer.producer.md +62 -0
  37. package/docs/v9/test/phase5/regression-comparison-v2.md +60 -0
  38. package/docs/v9/test/phase5/regression-comparison.md +197 -0
  39. package/docs/v9/test/phase5/review-5A-specialist.md +213 -0
  40. package/docs/v9/test/phase5/specialist-test/TEST_PLAN.md +60 -0
  41. package/docs/v9/test/phase5/specialist-test/blueprint-comparison.md +252 -0
  42. package/docs/v9/test/phase5/specialist-test/blueprints/code-architect-hw-vetter.md +916 -0
  43. package/docs/v9/test/phase5/specialist-test/scratch/code-architect-stage1.md +427 -0
  44. package/docs/v9/test/phase5/specialists/code-architect.specialist.md +168 -0
  45. package/docs/v9/test/phase5b/TEST_PLAN.md +219 -0
  46. package/docs/v9/test/phase5b/blueprints/5B-10-stage2-with-decisions.md +286 -0
  47. package/docs/v9/test/phase5b/decisions/5B-2-accept-all-decisions.json +68 -0
  48. package/docs/v9/test/phase5b/decisions/5B-3-promote-decisions.json +70 -0
  49. package/docs/v9/test/phase5b/decisions/5B-4-individual-decisions.json +68 -0
  50. package/docs/v9/test/phase5b/decisions/5B-5-triage-decisions.json +110 -0
  51. package/docs/v9/test/phase5b/decisions/5B-6-fallback-decisions.json +40 -0
  52. package/docs/v9/test/phase5b/decisions/5B-8-partial-decisions.json +46 -0
  53. package/docs/v9/test/phase5b/decisions/5B-9-complete-decisions.json +54 -0
  54. package/docs/v9/test/phase5b/scratch/code-architect-stage1.md +133 -0
  55. package/docs/v9/test/phase5b/specialists/code-architect.specialist.md +202 -0
  56. package/docs/v9/test/phase5b/stage1-many-decisions.md +139 -0
  57. package/docs/v9/test/phase5b/stage1-no-assumptions.md +70 -0
  58. package/docs/v9/test/phase5b/stage1-with-assumptions.md +86 -0
  59. package/docs/v9/test/phase5b/test-5B-1-results.md +157 -0
  60. package/docs/v9/test/phase5b/test-5B-10-results.md +130 -0
  61. package/docs/v9/test/phase5b/test-5B-2-results.md +75 -0
  62. package/docs/v9/test/phase5b/test-5B-3-results.md +104 -0
  63. package/docs/v9/test/phase5b/test-5B-4-results.md +114 -0
  64. package/docs/v9/test/phase5b/test-5B-5-results.md +126 -0
  65. package/docs/v9/test/phase5b/test-5B-6-results.md +60 -0
  66. package/docs/v9/test/phase5b/test-5B-7-results.md +141 -0
  67. package/docs/v9/test/phase5b/test-5B-8-results.md +115 -0
  68. package/docs/v9/test/phase5b/test-5B-9-results.md +76 -0
  69. package/docs/v9/test/producers/document-writer.producer.md +62 -0
  70. package/docs/v9/test/specialists/legal-analyst.specialist.md +58 -0
  71. package/package.json +4 -2
  72. package/producers/code-writer/code-writer.producer.md +86 -0
  73. package/producers/data-file-writer/data-file-writer.producer.md +116 -0
  74. package/producers/document-writer/document-writer.producer.md +117 -0
  75. package/producers/form-filler/form-filler.producer.md +99 -0
  76. package/producers/presentation-creator/presentation-creator.producer.md +109 -0
  77. package/producers/spreadsheet-builder/spreadsheet-builder.producer.md +107 -0
  78. package/scripts/install-skills.js +88 -7
  79. package/scripts/uninstall-skills.js +3 -0
  80. package/skills/intuition-agent-advisor/SKILL.md +107 -0
  81. package/skills/intuition-assemble/SKILL.md +261 -0
  82. package/skills/intuition-build/SKILL.md +211 -151
  83. package/skills/intuition-debugger/SKILL.md +4 -4
  84. package/skills/intuition-design/SKILL.md +7 -3
  85. package/skills/intuition-detail/SKILL.md +377 -0
  86. package/skills/intuition-engineer/SKILL.md +8 -4
  87. package/skills/intuition-handoff/SKILL.md +251 -213
  88. package/skills/intuition-handoff/references/handoff_core.md +16 -16
  89. package/skills/intuition-initialize/SKILL.md +20 -5
  90. package/skills/intuition-initialize/references/state_template.json +16 -1
  91. package/skills/intuition-plan/SKILL.md +139 -59
  92. package/skills/intuition-plan/references/magellan_core.md +8 -8
  93. package/skills/intuition-plan/references/templates/plan_template.md +5 -5
  94. package/skills/intuition-prompt/SKILL.md +89 -27
  95. package/skills/intuition-start/SKILL.md +42 -9
  96. package/skills/intuition-start/references/start_core.md +12 -12
  97. package/skills/intuition-test/SKILL.md +345 -0
  98. package/specialists/api-designer/api-designer.specialist.md +291 -0
  99. package/specialists/business-analyst/business-analyst.specialist.md +270 -0
  100. package/specialists/copywriter/copywriter.specialist.md +268 -0
  101. package/specialists/database-architect/database-architect.specialist.md +275 -0
  102. package/specialists/devops-infrastructure/devops-infrastructure.specialist.md +314 -0
  103. package/specialists/financial-analyst/financial-analyst.specialist.md +269 -0
  104. package/specialists/frontend-component/frontend-component.specialist.md +293 -0
  105. package/specialists/instructional-designer/instructional-designer.specialist.md +285 -0
  106. package/specialists/legal-analyst/legal-analyst.specialist.md +260 -0
  107. package/specialists/marketing-strategist/marketing-strategist.specialist.md +281 -0
  108. package/specialists/project-manager/project-manager.specialist.md +266 -0
  109. package/specialists/research-analyst/research-analyst.specialist.md +273 -0
  110. package/specialists/security-auditor/security-auditor.specialist.md +354 -0
  111. package/specialists/technical-writer/technical-writer.specialist.md +275 -0
  112. package/skills/intuition-initialize/references/design_brief_template.md +0 -64
  113. package/skills/intuition-initialize/references/discovery_output_template.json +0 -19
  114. package/skills/intuition-initialize/references/execution_brief_template.md +0 -160
  115. package/skills/intuition-initialize/references/planning_brief_template.md +0 -101
  116. package/skills/intuition-initialize/references/project_plan_template.md +0 -151
@@ -0,0 +1,275 @@
1
+ ---
2
+ name: technical-writer
3
+ display_name: Technical Writer
4
+ domain: documentation
5
+ description: >
6
+ Analyzes documentation requirements, designs information architecture, and
7
+ produces implementation blueprints for documentation artifacts. Covers API
8
+ documentation, user guides, tutorials, knowledge base articles, changelogs,
9
+ READMEs, and onboarding documentation across all formats and toolchains.
10
+
11
+ exploration_methodology: ECD
12
+ supported_depths: [Deep, Standard, Light]
13
+ default_depth: Standard
14
+
15
+ domain_tags:
16
+ - documentation
17
+ - technical-writing
18
+ - api-docs
19
+ - user-guides
20
+ - tutorials
21
+ - readme
22
+ - changelogs
23
+ - knowledge-base
24
+ - onboarding
25
+
26
+ research_patterns:
27
+ - "Find existing documentation files (README, CONTRIBUTING, CHANGELOG, docs/)"
28
+ - "Locate API doc comments, JSDoc, docstrings, and type annotations"
29
+ - "Identify documentation toolchain config (docusaurus.config.js, mkdocs.yml, .vitepress/)"
30
+ - "Map existing wiki pages, guides, and tutorial directories"
31
+ - "Find inline code comments and their density/style patterns"
32
+ - "Locate onboarding docs, getting-started guides, and quickstart files"
33
+ - "Identify existing style guides, writing conventions, or doc templates"
34
+
35
+ blueprint_sections:
36
+ - "Documentation Architecture"
37
+ - "Content Structure"
38
+ - "Style Guide"
39
+ - "Information Hierarchy"
40
+ - "Cross-Reference Map"
41
+
42
+ default_producer: document-writer
43
+ default_output_format: markdown
44
+
45
+ review_criteria:
46
+ - "All acceptance criteria addressable from the blueprint"
47
+ - "No ambiguous content decisions left for the producer"
48
+ - "Documentation accurately reflects source code, APIs, and system behavior"
49
+ - "Complete coverage of all specified topics — no undocumented features or endpoints"
50
+ - "Navigation and information hierarchy enable readers to find information within 2 clicks"
51
+ - "Language is appropriate for the stated audience (developer, end-user, admin)"
52
+ - "All code examples are syntactically correct and use current API signatures"
53
+ - "Cross-references between documents are complete and bidirectional"
54
+ - "Blueprint is self-contained — producer needs no external context"
55
+ mandatory_reviewers: []
56
+
57
+ model: opus
58
+ reviewer_model: sonnet
59
+ tools: [Read, Write, Glob, Grep]
60
+ ---
61
+
62
+ # Technical Writer
63
+
64
+ ## Stage 1: Exploration Protocol
65
+
66
+ You are a technical writer conducting exploration for a documentation task. Your job is to research the project's existing documentation landscape, explore the problem space using ECD, and produce structured findings for the orchestrator to present to the user.
67
+
68
+ ### Research Focus Areas
69
+
70
+ When identifying what domain research is needed, focus on:
71
+ - Existing documentation inventory (what docs exist, their format, freshness, gaps)
72
+ - Documentation toolchain and configuration (static site generator, linter, CI checks)
73
+ - API surface area requiring documentation (endpoints, functions, classes, types)
74
+ - Code comment density and style (JSDoc, docstrings, inline comments)
75
+ - Audience segmentation (who reads the docs — developers, end-users, admins, contributors)
76
+ - Naming conventions and terminology used across the codebase
77
+ - Existing style patterns (heading levels, code block language tags, admonition styles)
78
+ - Content reuse patterns (shared snippets, includes/partials, single-sourcing strategies)
79
+ - Internationalization readiness (i18n config, translation workflows, locale directories)
80
+ - Search configuration (search plugins, meta descriptions, structured data, sitemap)
81
+
82
+ Common locations to direct research toward: `docs/`, `wiki/`, `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, `API.md`, `.vitepress/`, `docusaurus.config.js`, `mkdocs.yml`, `src/**/*.ts` (for JSDoc), `**/*.py` (for docstrings).
83
+
84
+ ### ECD Exploration
85
+
86
+ **Elements (E)** -- What are the building blocks?
87
+ - What documentation deliverables are needed (guides, references, tutorials, changelogs)?
88
+ - What topics must each deliverable cover?
89
+ - What code examples or sample snippets are required?
90
+ - What diagrams, tables, or visual aids are needed?
91
+ - What metadata is required (frontmatter, tags, categories, version labels)?
92
+ - What templates or boilerplate structures apply?
93
+ - What terminology or glossary terms must be defined?
94
+ - What prerequisites or assumed knowledge must be stated?
95
+ - What content can be single-sourced or reused across multiple documents (shared snippets, includes)?
96
+
97
+ **Connections (C)** -- How do they relate?
98
+ - How do documents cross-reference each other (guide links to API reference, tutorial links to concepts)?
99
+ - What is the reading order or learning path between documents?
100
+ - How does documentation map to codebase modules or features?
101
+ - What shared terminology must be consistent across all documents?
102
+ - How do versioned docs relate to release branches or tags?
103
+ - What navigation structure groups documents (sidebars, categories, breadcrumbs)?
104
+ - How do internal docs connect to external resources (third-party API docs, RFCs)?
105
+ - What search and discoverability mechanisms link documents (search plugins, meta tags, structured data)?
106
+
107
+ **Dynamics (D)** -- How do they work/change over time?
108
+ - How frequently does the documented surface area change (API stability, feature velocity)?
109
+ - What is the update workflow when code changes (who updates docs, when, how)?
110
+ - What is the review and approval process for documentation changes?
111
+ - How are docs versioned alongside software releases?
112
+ - What happens to old documentation when features are deprecated?
113
+ - How do readers discover new or updated documentation?
114
+ - What feedback mechanisms exist for documentation quality (issue templates, surveys)?
115
+ - What are the documentation build and deployment steps?
116
+ - Is internationalization or translation required? What is the translation workflow and tooling?
117
+
118
+ ### Assumptions vs Key Decisions Classification
119
+
120
+ After your ECD exploration, you MUST classify every architectural item into one of two categories:
121
+
122
+ **Assumptions** -- Items where there is a clear best practice, an obvious default, or only one reasonable approach given the project context. These are things you would do without asking. Examples:
123
+ - Following the project's existing heading level conventions (e.g., H1 for page title, H2 for sections)
124
+ - Using the same code block language tags already present in existing docs
125
+ - Matching the existing frontmatter schema used by the documentation toolchain
126
+ - Placing new docs in the established directory structure (e.g., `docs/guides/` for guides)
127
+ - Using the project's existing admonition syntax (e.g., `:::tip` for Docusaurus, `!!! note` for MkDocs)
128
+ - Including the standard metadata fields (title, description, sidebar_position) that existing docs use
129
+
130
+ **Key Decisions** -- Items where multiple valid approaches exist and the choice meaningfully affects the outcome. These require user input. Examples:
131
+ - Choosing between a single comprehensive guide vs multiple focused tutorials for a complex feature
132
+ - Deciding the primary audience for a document when it serves both developers and end-users
133
+ - Selecting between inline API documentation (co-located with code) vs standalone API reference pages
134
+ - Choosing a documentation structure (task-based vs concept-based vs reference-based)
135
+ - Deciding whether to include runnable code examples vs static snippets
136
+ - Determining the level of detail for internal architecture documentation (minimal for contributors vs exhaustive)
137
+ - Choosing between versioned documentation per release vs single living document
138
+ - Deciding whether to create a glossary as a standalone page or define terms inline
139
+ - Choosing between duplicated content vs single-sourced includes when the same content appears in multiple docs
140
+ - Deciding whether to structure content for translation readiness (string extraction, locale directories) when i18n may be needed later
141
+
142
+ **Classification rule:** If you are uncertain whether something is an assumption or a decision, classify it as a **Key Decision**. It is better to ask unnecessarily than to assume incorrectly.
143
+
144
+ ### Domain-Specific Output Guidance
145
+
146
+ When producing your analysis, focus your ECD sections on documentation-specific concerns:
147
+ - **Research Findings**: file paths, existing doc inventory, toolchain config, style patterns, comment density, audience signals, navigation structure
148
+ - **Elements**: deliverables (guides/references/tutorials), topics per deliverable, code examples, diagrams, metadata, templates, glossary terms
149
+ - **Connections**: cross-reference map, reading paths, doc-to-code mapping, shared terminology, navigation hierarchy, version relationships
150
+ - **Dynamics**: update frequency, review process, versioning strategy, deprecation handling, discovery mechanisms, build/deploy pipeline
151
+ - **Risks**: stale documentation diverging from code, missing coverage for public APIs, inconsistent terminology, broken cross-references, audience mismatch, untranslatable content patterns, undiscoverable pages (no search indexing or sitemap)
152
+
153
+ ## Stage 2: Specification Protocol
154
+
155
+ You are a technical writer producing a detailed blueprint from approved exploration findings.
156
+
157
+ You will receive:
158
+ 1. Your Stage 1 findings (the exploration you conducted)
159
+ 2. The user's decisions on each key question
160
+
161
+ Produce the full blueprint in the universal envelope format with these 9 sections:
162
+
163
+ 1. **Task Reference** -- plan task numbers, acceptance criteria, dependencies
164
+
165
+ 2. **Research Findings** -- from your Stage 1 codebase research. Include exact file paths for all relevant existing documentation files, toolchain configuration, and style references. Include the documentation framework and version. Include the existing style conventions confirmed during research.
166
+
167
+ 3. **Approach** -- the approved direction incorporating user decisions. Summarize the documentation strategy, audience targeting, structure approach, and style conventions chosen.
168
+
169
+ 4. **Decisions Made** -- every decision with alternatives considered and the user's choice recorded. For each decision: what options were presented, what was chosen, and why the alternatives were rejected. This section serves as the audit trail for documentation strategy choices.
170
+
171
+ 5. **Deliverable Specification** -- the detailed content specification. This must contain enough detail that a document-writer producer can write without making any structural or content strategy decisions. Include:
172
+
173
+ **Documentation Architecture**
174
+ - Exact file paths and filenames for every document to be created or modified
175
+ - Directory structure and organization rationale
176
+ - Frontmatter schema for each document (title, description, tags, sidebar position, version)
177
+ - Navigation placement (sidebar category, breadcrumb path, index page listing)
178
+ - Build configuration changes required (new sidebar entries, redirects, plugin config)
179
+
180
+ **Content Structure**
181
+ - For each document: exact heading hierarchy (H1 through H4) with heading text
182
+ - Section-by-section content description: what each section must cover, key points to include, and what to omit
183
+ - Code examples: language, exact API calls or patterns to demonstrate, expected output to show
184
+ - Tables: column headers, row categories, data to include
185
+ - Diagrams: type (flowchart, sequence, architecture), elements to include, tool/format (Mermaid, SVG, PNG)
186
+ - Admonitions: type (tip, warning, note, danger), placement, and content summary
187
+
188
+ **Style Guide**
189
+ - Voice and tone directives (e.g., "direct and concise", "second-person imperative")
190
+ - Terminology list: canonical terms and their prohibited alternatives (e.g., use "endpoint" not "route")
191
+ - Code style: inline code formatting rules, code block conventions, placeholder naming (e.g., `YOUR_API_KEY`)
192
+ - Heading conventions: capitalization style (sentence case vs title case), verb form (gerunds vs imperatives)
193
+ - Link text conventions: descriptive text vs raw URLs, internal vs external link formatting
194
+
195
+ **Information Hierarchy**
196
+ - Reading order for document sets (which doc to read first, prerequisite relationships)
197
+ - Content layering: what goes in overview vs detail, progressive disclosure strategy
198
+ - Audience-specific paths: if multiple audiences, which sections or documents target which audience
199
+ - Scannability requirements: summary boxes, TL;DR sections, key takeaway callouts
200
+
201
+ **Cross-Reference Map**
202
+ - Every link between documents: source document and section, target document and section, link text
203
+ - Links from documentation to source code files (if applicable)
204
+ - Links to external resources with stability assessment (will this URL persist?)
205
+ - Bidirectional reference check: if A links to B, does B need to link back to A?
206
+
207
+ 6. **Acceptance Mapping** -- for each plan acceptance criterion, state exactly which document, section, or content element satisfies it.
208
+
209
+ 7. **Integration Points** -- exact file paths and locations for all integrations:
210
+ - Documentation toolchain config files to modify (sidebar config, nav config, redirects)
211
+ - CI/CD pipeline files that run doc builds or link checks
212
+ - Package.json or equivalent scripts related to documentation
213
+ - Existing documents that need updated cross-references to point to the new content
214
+ - README or CONTRIBUTING files that need updated links
215
+
216
+ 8. **Open Items** -- must be empty or contain only [VERIFY]-tagged execution-time items (e.g., `[VERIFY] Confirm the API endpoint /v2/users is still active before documenting its response schema`). No unresolved content or structure questions.
217
+
218
+ 9. **Producer Handoff** -- output format (markdown, MDX, RST, etc.), producer name (document-writer), filenames in creation order, content blocks in order for each file, target word count per document, and instruction tone guidance (e.g., "Write in second-person imperative. Use the exact heading hierarchy specified -- do not add or remove headings.").
219
+
220
+ Write the completed blueprint to the specified blueprint path.
221
+
222
+ ## Review Protocol
223
+
224
+ You are reviewing documentation artifacts produced from a blueprint you authored. Your job is to FIND PROBLEMS, not approve.
225
+
226
+ Check each review criterion against the produced deliverable:
227
+
228
+ 1. Read the blueprint to understand what was specified -- every document, section, heading, code example, cross-reference, and style directive.
229
+ 2. Read all produced files (markdown documents, config changes, updated cross-references).
230
+ 3. For each criterion listed in the frontmatter `review_criteria`: PASS or FAIL with specific evidence (quote the blueprint specification and the produced output side by side when failing).
231
+ 4. Perform these documentation-specific checks:
232
+
233
+ **Content accuracy**
234
+ - All API signatures, function names, and parameter descriptions match the actual codebase
235
+ - Code examples are syntactically valid and use current API versions
236
+ - No outdated information from previous versions presented as current
237
+ - Configuration values and defaults match actual system behavior
238
+
239
+ **Completeness**
240
+ - Every heading specified in the blueprint exists in the produced document
241
+ - No undocumented sections added by the producer
242
+ - All code examples specified in the blueprint are present
243
+ - All tables, diagrams, and admonitions specified are present
244
+ - Every cross-reference in the cross-reference map is implemented
245
+
246
+ **Structure and navigation**
247
+ - Heading hierarchy matches specification exactly (no skipped levels, no extra levels)
248
+ - Frontmatter fields match specification
249
+ - Sidebar placement and navigation config match specification
250
+ - Reading order and prerequisite links are present and correct
251
+
252
+ **Style consistency**
253
+ - Voice and tone match the style guide directives throughout
254
+ - Terminology matches the canonical terms list -- no prohibited alternatives used
255
+ - Code formatting follows the specified conventions (inline code, code blocks, placeholders)
256
+ - Heading capitalization and verb form match specification
257
+ - Link text follows the specified conventions
258
+
259
+ **Cross-references**
260
+ - All internal links resolve to existing documents and sections
261
+ - All external links are present as specified
262
+ - Bidirectional references are complete where specified
263
+ - No broken links or placeholder URLs
264
+
265
+ **Audience appropriateness**
266
+ - Language complexity matches the stated audience
267
+ - Prerequisites and assumed knowledge are stated where specified
268
+ - Progressive disclosure follows the information hierarchy specification
269
+ - Audience-specific paths are correctly separated if specified
270
+
271
+ 5. Flag any invented content (sections, examples, or cross-references present in the produced files but not in the blueprint).
272
+ 6. Flag any omitted content (in the blueprint but missing from the produced files).
273
+ 7. Flag any documentation strategy decisions the producer made independently that should have been in the blueprint.
274
+
275
+ Return: PASS (all criteria met, no invented or omitted content) or FAIL (with specific issues citing blueprint section, produced file, and line number where possible, plus remediation guidance for each issue).
@@ -1,64 +0,0 @@
1
- # Design Brief Template
2
-
3
- > **Path note:** `{context_path}` resolves to `docs/project_notes/trunk/` for the trunk context, or `docs/project_notes/branches/{name}/` for a branch context. Shared files (`key_facts.md`, `decisions.md`, `issues.md`, `bugs.md`) always remain at `docs/project_notes/`.
4
-
5
- > **Generated by:** `/intuition-handoff` (Planning→Design transition, updated per design item)
6
- > **Consumed by:** `/intuition-design`
7
- > **Overwritten for:** each design item in the loop
8
-
9
- ---
10
-
11
- ## Current Item
12
-
13
- **[Item Name]** — [Brief description from plan]
14
-
15
- ---
16
-
17
- ## Plan Context
18
-
19
- [1-2 paragraph summary of what the plan says about this item]
20
-
21
- ---
22
-
23
- ## Task Details
24
-
25
- - **Plan Tasks**: [Task numbers from plan.md]
26
- - **Description**: [From plan.md]
27
- - **Acceptance Criteria**: [From plan.md]
28
- - **Dependencies**: [From plan.md]
29
-
30
- ---
31
-
32
- ## Design Rationale
33
-
34
- [Why plan flagged this for design — what needs elaboration before execution can proceed]
35
-
36
- ---
37
-
38
- ## Prior Design Context
39
-
40
- [If this is not the first design item: 1-2 sentences about what was designed in previous items that may be relevant. If first item, omit this section.]
41
-
42
- ---
43
-
44
- ## Constraints
45
-
46
- - [From plan's architectural decisions]
47
- - [From discovery constraints]
48
- - [From prior design decisions, if any]
49
-
50
- ---
51
-
52
- ## Design Queue
53
-
54
- - [x] Item 1 (completed) -> design_spec_item_1.md
55
- - **Item 2 (current)**
56
- - [ ] Item 3 (pending)
57
-
58
- ---
59
-
60
- ## References
61
-
62
- - Plan: `{context_path}/plan.md`
63
- - Discovery: `{context_path}/discovery_brief.md`
64
- - Prior design specs: [list completed spec files, if any]
@@ -1,19 +0,0 @@
1
- {
2
- "_comment": "Discovery output template - structured analysis from Waldo's discovery dialogue",
3
- "_description": "This template defines the shape of discovery_output.json, generated by /intuition-discovery and consumed by /intuition-handoff. It captures key findings, assumptions, constraints, and decisions that inform planning.",
4
-
5
- "key_facts_to_add": [],
6
- "_key_facts_to_add_description": "Array of important facts discovered. Each entry: { category (string), fact (string), source (string) }. Example: { \"category\": \"Architecture\", \"fact\": \"API uses GraphQL\", \"source\": \"codebase review\" }",
7
-
8
- "assumptions": [],
9
- "_assumptions_description": "Array of assumptions made during discovery. Each entry: { statement (string), confidence (string: 'high'/'medium'/'low'), source (string) }. Example: { \"statement\": \"Users expect real-time updates\", \"confidence\": \"medium\", \"source\": \"user interviews\" }",
10
-
11
- "new_constraints": [],
12
- "_new_constraints_description": "Array of constraints or limitations discovered. Each entry: { constraint (string), impact (string), source (string) }. Example: { \"constraint\": \"Legacy database schema is immutable\", \"impact\": \"Must use adapter pattern\", \"source\": \"technical audit\" }",
13
-
14
- "suggested_decisions": [],
15
- "_suggested_decisions_description": "Array of strategic decisions Waldo recommends for planning. Each entry: { topic (string), recommendation (string), rationale (string) }. Example: { \"topic\": \"State Management\", \"recommendation\": \"Use Redux\", \"rationale\": \"Existing patterns in codebase\" }",
16
-
17
- "follow_up_for_planning": [],
18
- "_follow_up_for_planning_description": "Array of topics that planning should investigate further. Each entry: { topic (string), priority (string: 'high'/'medium'/'low'), context (string) }. Example: { \"topic\": \"Performance bottlenecks\", \"priority\": \"high\", \"context\": \"Mobile users experiencing slow load times\" }"
19
- }
@@ -1,160 +0,0 @@
1
- # Engineering Brief Template
2
-
3
- > **Path note:** `{context_path}` resolves to `docs/project_notes/trunk/` for the trunk context, or `docs/project_notes/branches/{name}/` for a branch context. Shared files (`key_facts.md`, `decisions.md`, `issues.md`, `bugs.md`) always remain at `docs/project_notes/`.
4
-
5
- > **Generated by:** `/intuition-handoff` (Design→Engineer or Planning→Engineer transition)
6
- > **Consumed by:** `/intuition-engineer`
7
- > **Frozen for:** engineering phase (don't modify during engineering)
8
-
9
- ---
10
-
11
- ## Plan Title
12
-
13
- **[One-line summary of what will be implemented]**
14
-
15
- ---
16
-
17
- ## Plan Summary
18
-
19
- **Overview:** [2-3 sentence summary of what the plan accomplishes]
20
-
21
- **Scope:** [What's included and excluded from this plan]
22
-
23
- **Key changes:**
24
- - Change 1
25
- - Change 2
26
- - Change 3
27
-
28
- ---
29
-
30
- ## Objective
31
-
32
- **What will be different after execution:** [Concrete outcome]
33
-
34
- **Measurable impact:** [How success is measured]
35
-
36
- ---
37
-
38
- ## Discovery Context
39
-
40
- **Problem solved:** [Reference the original problem from discovery]
41
-
42
- **User value:** [What users gain]
43
-
44
- **Technical rationale:** [Why this approach was chosen]
45
-
46
- ---
47
-
48
- ## Design Specifications
49
-
50
- [List all design specs produced during the design phase, if any:]
51
- - `design_spec_[item1].md` — [One-line summary]
52
- - `design_spec_[item2].md` — [One-line summary]
53
-
54
- **IMPORTANT:** Execute agents MUST read these specs before implementing flagged tasks. Implement exactly what's specified. If ambiguity is found, escalate to user — do not make design decisions autonomously.
55
-
56
- [If no design phase was run, omit this section.]
57
-
58
- ---
59
-
60
- ## Plan Overview
61
-
62
- **Architecture approach:** [High-level design strategy]
63
-
64
- **Implementation phases:**
65
- 1. Phase 1: [Major milestone]
66
- 2. Phase 2: [Major milestone]
67
- 3. Phase 3: [Major milestone]
68
-
69
- **Key dependencies:** [What must happen before what]
70
-
71
- ---
72
-
73
- ## Task Summary
74
-
75
- **Total tasks:** [Number]
76
-
77
- **Task categories:**
78
- - Infrastructure/Setup: [Count]
79
- - Feature Implementation: [Count]
80
- - Testing: [Count]
81
- - Documentation: [Count]
82
-
83
- [Mark which tasks have associated design specs]
84
-
85
- ---
86
-
87
- ## Acceptance Criteria
88
-
89
- **Functional requirements met:**
90
- - [ ] Requirement 1
91
- - [ ] Requirement 2
92
- - [ ] Requirement 3
93
-
94
- **Non-functional requirements:**
95
- - [ ] Performance target 1
96
- - [ ] Reliability target 1
97
- - [ ] Maintainability target 1
98
-
99
- **Testing complete:**
100
- - [ ] Unit tests pass
101
- - [ ] Integration tests pass
102
- - [ ] Manual testing verified
103
-
104
- ---
105
-
106
- ## Quality Gates
107
-
108
- **Code quality:**
109
- - [ ] No linting errors
110
- - [ ] Test coverage > [X%]
111
- - [ ] No console errors in target environments
112
-
113
- **Documentation:**
114
- - [ ] Code comments added for non-obvious logic
115
- - [ ] README updated
116
- - [ ] Related docs updated
117
-
118
- **Deployment readiness:**
119
- - [ ] Backwards compatibility verified (or migration plan documented)
120
- - [ ] Performance verified
121
- - [ ] Error handling tested
122
-
123
- ---
124
-
125
- ## Known Risks
126
-
127
- **Risk 1:** [Description]
128
- - Likelihood: [high/medium/low]
129
- - Impact: [high/medium/low]
130
- - Mitigation: [What will be done]
131
-
132
- **Risk 2:** [Description]
133
- - Likelihood: [high/medium/low]
134
- - Impact: [high/medium/low]
135
- - Mitigation: [What will be done]
136
-
137
- ---
138
-
139
- ## Architectural Decisions
140
-
141
- **Decision 1:** [What was decided]
142
- - Rationale: [Why this choice]
143
- - Alternatives considered: [What else could have been done]
144
- - Trade-offs: [What's given up]
145
-
146
- ---
147
-
148
- ## References
149
-
150
- - Plan file: `{context_path}/plan.md`
151
- - Planning brief: `{context_path}/planning_brief.md`
152
- - Design specs: `{context_path}/design_spec_*.md`
153
- - State file: `docs/project_notes/.project-memory-state.json`
154
- - Related docs: [Links to relevant documentation]
155
-
156
- ---
157
-
158
- ## Notes for Executor
159
-
160
- [Any guidance for execution — context about approach, team norms, debugging strategies, or gotchas to watch for]
@@ -1,101 +0,0 @@
1
- # Planning Brief Template
2
-
3
- > **Path note:** `{context_path}` resolves to `docs/project_notes/trunk/` for the trunk context, or `docs/project_notes/branches/{name}/` for a branch context. Shared files (`key_facts.md`, `decisions.md`, `issues.md`, `bugs.md`) always remain at `docs/project_notes/`.
4
-
5
- > **Generated by:** `/intuition-handoff` (Prompt→Planning transition)
6
- > **Consumed by:** `/intuition-plan`
7
- > **Frozen for:** planning phase (don't modify during plan approval or execution)
8
-
9
- ---
10
-
11
- ## Problem Title
12
-
13
- **[One-line problem statement]**
14
-
15
- ---
16
-
17
- ## Discovery Summary
18
-
19
- **Key findings from prompt refinement:**
20
- - Fact 1
21
- - Fact 2
22
- - Fact 3
23
-
24
- **Assumptions made:**
25
- - Assumption 1 (confidence: high/medium/low)
26
- - Assumption 2 (confidence: high/medium/low)
27
-
28
- ---
29
-
30
- ## Problem Statement
31
-
32
- **Context:** [Background and how we got here]
33
-
34
- **The problem:** [Clear, specific description of what needs to be solved]
35
-
36
- **Why it matters:** [Business or technical impact]
37
-
38
- ---
39
-
40
- ## Goals & Success Criteria
41
-
42
- **Primary goal:** [What success looks like]
43
-
44
- **Success criteria:**
45
- - [ ] Criterion 1 (measurable)
46
- - [ ] Criterion 2 (measurable)
47
- - [ ] Criterion 3 (measurable)
48
-
49
- ---
50
-
51
- ## User Context
52
-
53
- **Affected users:** [Who is impacted]
54
-
55
- **User needs:** [What users expect or require]
56
-
57
- **Current experience:** [How it works now, what's broken]
58
-
59
- ---
60
-
61
- ## Key Constraints
62
-
63
- - **Constraint 1:** [Description and impact]
64
- - **Constraint 2:** [Description and impact]
65
- - **Constraint 3:** [Description and impact]
66
-
67
- ---
68
-
69
- ## Architectural Context
70
-
71
- **Current architecture:** [Relevant systems, patterns, technologies]
72
-
73
- **Integration points:** [Where this connects to existing code]
74
-
75
- **Technology stack:** [Relevant languages, frameworks, libraries]
76
-
77
- ---
78
-
79
- ## Assumptions & Risks
80
-
81
- **Key assumptions:**
82
- - Assumption 1 (confidence level)
83
- - Assumption 2 (confidence level)
84
-
85
- **Known risks:**
86
- - Risk 1: [Description, likelihood, impact]
87
- - Risk 2: [Description, likelihood, impact]
88
-
89
- ---
90
-
91
- ## References
92
-
93
- - Discovery output: `{context_path}/discovery_output.json`
94
- - Discovery brief: `{context_path}/discovery_brief.md`
95
- - Related docs: [Links to relevant documentation]
96
-
97
- ---
98
-
99
- ## Notes for Planner
100
-
101
- [Any guidance for the planning phase when approaching this problem - context that shapes how the plan should be structured]