dojo.md 0.2.1 → 0.2.3

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 (152) hide show
  1. package/courses/GENERATION_LOG.md +20 -0
  2. package/courses/api-documentation-writing/course.yaml +12 -0
  3. package/courses/api-documentation-writing/scenarios/level-1/authentication-basics.yaml +46 -0
  4. package/courses/api-documentation-writing/scenarios/level-1/data-types-formats.yaml +45 -0
  5. package/courses/api-documentation-writing/scenarios/level-1/endpoint-description.yaml +45 -0
  6. package/courses/api-documentation-writing/scenarios/level-1/error-documentation.yaml +45 -0
  7. package/courses/api-documentation-writing/scenarios/level-1/first-documentation-shift.yaml +47 -0
  8. package/courses/api-documentation-writing/scenarios/level-1/getting-started-guide.yaml +42 -0
  9. package/courses/api-documentation-writing/scenarios/level-1/pagination-docs.yaml +51 -0
  10. package/courses/api-documentation-writing/scenarios/level-1/request-parameters.yaml +46 -0
  11. package/courses/api-documentation-writing/scenarios/level-1/request-response-examples.yaml +48 -0
  12. package/courses/api-documentation-writing/scenarios/level-1/status-codes.yaml +45 -0
  13. package/courses/api-documentation-writing/scenarios/level-2/error-patterns.yaml +48 -0
  14. package/courses/api-documentation-writing/scenarios/level-2/intermediate-documentation-shift.yaml +48 -0
  15. package/courses/api-documentation-writing/scenarios/level-2/oauth-documentation.yaml +47 -0
  16. package/courses/api-documentation-writing/scenarios/level-2/openapi-specification.yaml +46 -0
  17. package/courses/api-documentation-writing/scenarios/level-2/rate-limiting-docs.yaml +45 -0
  18. package/courses/api-documentation-writing/scenarios/level-2/request-body-schemas.yaml +46 -0
  19. package/courses/api-documentation-writing/scenarios/level-2/schema-definitions.yaml +41 -0
  20. package/courses/api-documentation-writing/scenarios/level-2/swagger-redoc-rendering.yaml +43 -0
  21. package/courses/api-documentation-writing/scenarios/level-2/validation-documentation.yaml +47 -0
  22. package/courses/api-documentation-writing/scenarios/level-2/versioning-changelog.yaml +42 -0
  23. package/courses/api-documentation-writing/scenarios/level-3/advanced-documentation-shift.yaml +43 -0
  24. package/courses/api-documentation-writing/scenarios/level-3/api-style-guide.yaml +40 -0
  25. package/courses/api-documentation-writing/scenarios/level-3/code-samples-multilang.yaml +40 -0
  26. package/courses/api-documentation-writing/scenarios/level-3/content-architecture.yaml +47 -0
  27. package/courses/api-documentation-writing/scenarios/level-3/deprecation-communication.yaml +44 -0
  28. package/courses/api-documentation-writing/scenarios/level-3/interactive-api-explorer.yaml +42 -0
  29. package/courses/api-documentation-writing/scenarios/level-3/migration-guides.yaml +42 -0
  30. package/courses/api-documentation-writing/scenarios/level-3/sdk-documentation.yaml +40 -0
  31. package/courses/api-documentation-writing/scenarios/level-3/webhook-documentation.yaml +48 -0
  32. package/courses/api-documentation-writing/scenarios/level-3/websocket-sse-docs.yaml +47 -0
  33. package/courses/api-documentation-writing/scenarios/level-4/api-changelog-management.yaml +44 -0
  34. package/courses/api-documentation-writing/scenarios/level-4/api-governance-standards.yaml +41 -0
  35. package/courses/api-documentation-writing/scenarios/level-4/api-product-strategy.yaml +41 -0
  36. package/courses/api-documentation-writing/scenarios/level-4/developer-portal-design.yaml +48 -0
  37. package/courses/api-documentation-writing/scenarios/level-4/docs-as-code.yaml +41 -0
  38. package/courses/api-documentation-writing/scenarios/level-4/documentation-localization.yaml +46 -0
  39. package/courses/api-documentation-writing/scenarios/level-4/documentation-metrics.yaml +45 -0
  40. package/courses/api-documentation-writing/scenarios/level-4/documentation-testing.yaml +41 -0
  41. package/courses/api-documentation-writing/scenarios/level-4/expert-documentation-shift.yaml +45 -0
  42. package/courses/api-documentation-writing/scenarios/level-4/multi-audience-docs.yaml +46 -0
  43. package/courses/api-documentation-writing/scenarios/level-5/ai-powered-documentation.yaml +44 -0
  44. package/courses/api-documentation-writing/scenarios/level-5/api-first-documentation.yaml +45 -0
  45. package/courses/api-documentation-writing/scenarios/level-5/api-marketplace-docs.yaml +42 -0
  46. package/courses/api-documentation-writing/scenarios/level-5/board-api-strategy.yaml +48 -0
  47. package/courses/api-documentation-writing/scenarios/level-5/documentation-program-strategy.yaml +42 -0
  48. package/courses/api-documentation-writing/scenarios/level-5/documentation-team-structure.yaml +47 -0
  49. package/courses/api-documentation-writing/scenarios/level-5/dx-competitive-advantage.yaml +46 -0
  50. package/courses/api-documentation-writing/scenarios/level-5/ecosystem-documentation.yaml +45 -0
  51. package/courses/api-documentation-writing/scenarios/level-5/industry-documentation-patterns.yaml +46 -0
  52. package/courses/api-documentation-writing/scenarios/level-5/master-documentation-shift.yaml +46 -0
  53. package/courses/code-review-feedback-writing/course.yaml +12 -0
  54. package/courses/code-review-feedback-writing/scenarios/level-1/approve-vs-request-changes.yaml +48 -0
  55. package/courses/code-review-feedback-writing/scenarios/level-1/asking-questions.yaml +50 -0
  56. package/courses/code-review-feedback-writing/scenarios/level-1/clear-comment-writing.yaml +45 -0
  57. package/courses/code-review-feedback-writing/scenarios/level-1/constructive-tone.yaml +43 -0
  58. package/courses/code-review-feedback-writing/scenarios/level-1/first-review-shift.yaml +46 -0
  59. package/courses/code-review-feedback-writing/scenarios/level-1/giving-praise.yaml +44 -0
  60. package/courses/code-review-feedback-writing/scenarios/level-1/nitpick-etiquette.yaml +44 -0
  61. package/courses/code-review-feedback-writing/scenarios/level-1/providing-context.yaml +46 -0
  62. package/courses/code-review-feedback-writing/scenarios/level-1/reviewing-small-prs.yaml +43 -0
  63. package/courses/code-review-feedback-writing/scenarios/level-1/style-vs-logic.yaml +48 -0
  64. package/courses/code-review-feedback-writing/scenarios/level-2/architectural-feedback.yaml +52 -0
  65. package/courses/code-review-feedback-writing/scenarios/level-2/intermediate-review-shift.yaml +46 -0
  66. package/courses/code-review-feedback-writing/scenarios/level-2/performance-feedback.yaml +50 -0
  67. package/courses/code-review-feedback-writing/scenarios/level-2/reviewing-breaking-changes.yaml +44 -0
  68. package/courses/code-review-feedback-writing/scenarios/level-2/reviewing-complex-prs.yaml +43 -0
  69. package/courses/code-review-feedback-writing/scenarios/level-2/reviewing-documentation.yaml +47 -0
  70. package/courses/code-review-feedback-writing/scenarios/level-2/reviewing-error-handling.yaml +50 -0
  71. package/courses/code-review-feedback-writing/scenarios/level-2/reviewing-tests.yaml +53 -0
  72. package/courses/code-review-feedback-writing/scenarios/level-2/security-review-comments.yaml +50 -0
  73. package/courses/code-review-feedback-writing/scenarios/level-2/suggesting-alternatives.yaml +42 -0
  74. package/courses/code-review-feedback-writing/scenarios/level-3/cross-team-review.yaml +45 -0
  75. package/courses/code-review-feedback-writing/scenarios/level-3/mentoring-through-review.yaml +46 -0
  76. package/courses/code-review-feedback-writing/scenarios/level-3/reviewing-unfamiliar-code.yaml +43 -0
  77. package/courses/terraform-infrastructure-setup/scenarios/level-1/first-debugging-shift.yaml +66 -0
  78. package/courses/terraform-infrastructure-setup/scenarios/level-1/hcl-syntax-errors.yaml +65 -0
  79. package/courses/terraform-infrastructure-setup/scenarios/level-1/plan-output-reading.yaml +71 -0
  80. package/courses/terraform-infrastructure-setup/scenarios/level-1/provider-configuration.yaml +62 -0
  81. package/courses/terraform-infrastructure-setup/scenarios/level-1/resource-creation-failures.yaml +54 -0
  82. package/courses/terraform-infrastructure-setup/scenarios/level-1/resource-references.yaml +70 -0
  83. package/courses/terraform-infrastructure-setup/scenarios/level-1/state-file-basics.yaml +73 -0
  84. package/courses/terraform-infrastructure-setup/scenarios/level-1/terraform-fmt-validate.yaml +58 -0
  85. package/courses/terraform-infrastructure-setup/scenarios/level-1/variable-and-output-errors.yaml +78 -0
  86. package/courses/terraform-infrastructure-setup/scenarios/level-2/count-vs-for-each.yaml +58 -0
  87. package/courses/terraform-infrastructure-setup/scenarios/level-2/dependency-management.yaml +80 -0
  88. package/courses/terraform-infrastructure-setup/scenarios/level-2/intermediate-debugging-shift.yaml +66 -0
  89. package/courses/terraform-infrastructure-setup/scenarios/level-2/lifecycle-rules.yaml +51 -0
  90. package/courses/terraform-infrastructure-setup/scenarios/level-2/locals-and-expressions.yaml +58 -0
  91. package/courses/terraform-infrastructure-setup/scenarios/level-2/module-structure.yaml +75 -0
  92. package/courses/terraform-infrastructure-setup/scenarios/level-2/provisioner-pitfalls.yaml +64 -0
  93. package/courses/terraform-infrastructure-setup/scenarios/level-2/remote-state-backend.yaml +55 -0
  94. package/courses/terraform-infrastructure-setup/scenarios/level-2/terraform-import.yaml +55 -0
  95. package/courses/terraform-infrastructure-setup/scenarios/level-2/workspace-management.yaml +51 -0
  96. package/courses/terraform-infrastructure-setup/scenarios/level-3/advanced-debugging-shift.yaml +63 -0
  97. package/courses/terraform-infrastructure-setup/scenarios/level-3/api-rate-limiting.yaml +50 -0
  98. package/courses/terraform-infrastructure-setup/scenarios/level-3/conditional-resources.yaml +66 -0
  99. package/courses/terraform-infrastructure-setup/scenarios/level-3/drift-detection.yaml +66 -0
  100. package/courses/terraform-infrastructure-setup/scenarios/level-3/dynamic-blocks.yaml +71 -0
  101. package/courses/terraform-infrastructure-setup/scenarios/level-3/large-scale-refactoring.yaml +59 -0
  102. package/courses/terraform-infrastructure-setup/scenarios/level-3/multi-provider-config.yaml +69 -0
  103. package/courses/terraform-infrastructure-setup/scenarios/level-3/state-surgery.yaml +57 -0
  104. package/courses/terraform-infrastructure-setup/scenarios/level-3/terraform-cloud-enterprise.yaml +59 -0
  105. package/courses/terraform-infrastructure-setup/scenarios/level-3/terraform-debugging.yaml +51 -0
  106. package/courses/terraform-infrastructure-setup/scenarios/level-4/blast-radius-management.yaml +51 -0
  107. package/courses/terraform-infrastructure-setup/scenarios/level-4/cicd-pipeline-design.yaml +50 -0
  108. package/courses/terraform-infrastructure-setup/scenarios/level-4/compliance-as-code.yaml +46 -0
  109. package/courses/terraform-infrastructure-setup/scenarios/level-4/cost-estimation-governance.yaml +42 -0
  110. package/courses/terraform-infrastructure-setup/scenarios/level-4/expert-debugging-shift.yaml +51 -0
  111. package/courses/terraform-infrastructure-setup/scenarios/level-4/iac-organization-strategy.yaml +45 -0
  112. package/courses/terraform-infrastructure-setup/scenarios/level-4/incident-response-iac.yaml +47 -0
  113. package/courses/terraform-infrastructure-setup/scenarios/level-4/infrastructure-testing.yaml +41 -0
  114. package/courses/terraform-infrastructure-setup/scenarios/level-4/module-registry-design.yaml +45 -0
  115. package/courses/terraform-infrastructure-setup/scenarios/level-4/multi-account-strategy.yaml +57 -0
  116. package/courses/terraform-infrastructure-setup/scenarios/level-5/board-infrastructure-investment.yaml +53 -0
  117. package/courses/terraform-infrastructure-setup/scenarios/level-5/disaster-recovery-iac.yaml +47 -0
  118. package/courses/terraform-infrastructure-setup/scenarios/level-5/enterprise-iac-transformation.yaml +48 -0
  119. package/courses/terraform-infrastructure-setup/scenarios/level-5/iac-technology-evolution.yaml +49 -0
  120. package/courses/terraform-infrastructure-setup/scenarios/level-5/ma-infrastructure-consolidation.yaml +54 -0
  121. package/courses/terraform-infrastructure-setup/scenarios/level-5/master-debugging-shift.yaml +53 -0
  122. package/courses/terraform-infrastructure-setup/scenarios/level-5/multi-cloud-strategy.yaml +49 -0
  123. package/courses/terraform-infrastructure-setup/scenarios/level-5/platform-engineering.yaml +47 -0
  124. package/courses/terraform-infrastructure-setup/scenarios/level-5/regulatory-compliance-automation.yaml +47 -0
  125. package/courses/terraform-infrastructure-setup/scenarios/level-5/terraform-vs-alternatives.yaml +46 -0
  126. package/dist/cli/commands/generate.d.ts.map +1 -1
  127. package/dist/cli/commands/generate.js +2 -1
  128. package/dist/cli/commands/generate.js.map +1 -1
  129. package/dist/cli/commands/train.d.ts.map +1 -1
  130. package/dist/cli/commands/train.js +6 -3
  131. package/dist/cli/commands/train.js.map +1 -1
  132. package/dist/cli/index.js +9 -6
  133. package/dist/cli/index.js.map +1 -1
  134. package/dist/cli/run-demo.js +3 -2
  135. package/dist/cli/run-demo.js.map +1 -1
  136. package/dist/engine/model-utils.d.ts +6 -0
  137. package/dist/engine/model-utils.d.ts.map +1 -1
  138. package/dist/engine/model-utils.js +28 -1
  139. package/dist/engine/model-utils.js.map +1 -1
  140. package/dist/engine/training.d.ts.map +1 -1
  141. package/dist/engine/training.js +4 -3
  142. package/dist/engine/training.js.map +1 -1
  143. package/dist/generator/course-generator.d.ts.map +1 -1
  144. package/dist/generator/course-generator.js +4 -3
  145. package/dist/generator/course-generator.js.map +1 -1
  146. package/dist/mcp/server.d.ts.map +1 -1
  147. package/dist/mcp/server.js +7 -3
  148. package/dist/mcp/server.js.map +1 -1
  149. package/dist/mcp/session-manager.d.ts.map +1 -1
  150. package/dist/mcp/session-manager.js +3 -2
  151. package/dist/mcp/session-manager.js.map +1 -1
  152. package/package.json +3 -2
@@ -0,0 +1,45 @@
1
+ meta:
2
+ id: expert-documentation-shift
3
+ level: 4
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Combined expert shift — redesign an organization's entire API documentation program including governance, portal, testing, metrics, and team structure"
7
+ tags: [API, documentation, combined, shift-simulation, program, expert]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ You've been hired as Head of Developer Experience at a mid-size SaaS
13
+ company. The API documentation situation:
14
+
15
+ - 5 product teams, each maintaining docs differently
16
+ - 3 public APIs (payments, analytics, messaging) — 150 endpoints total
17
+ - Documentation in 3 places: Confluence wiki, README files, Swagger UI
18
+ - No style guide, no review process, no metrics
19
+ - Developer satisfaction survey: 3.2/10 for documentation
20
+ - Support ticket volume: 200/month, 60% are "how do I..." questions
21
+ - Competitor launched a developer portal — you're losing deals
22
+ - Budget: 2 technical writers, $200K for tooling
23
+
24
+ Your mandate: bring documentation satisfaction to 8/10 within 12 months
25
+ and reduce doc-related support tickets by 70%.
26
+
27
+ Task: Present your complete 12-month documentation transformation
28
+ plan. Include: current state assessment, target architecture,
29
+ tooling decisions, team structure, governance, metrics framework,
30
+ quarterly milestones, and the first 30-day quick wins. This is
31
+ your proposal to the VP of Engineering.
32
+
33
+ assertions:
34
+ - type: llm_judge
35
+ criteria: "Assessment and target state are clear — current state audit: catalog all documentation across Confluence/README/Swagger, identify gaps (undocumented endpoints, outdated pages, broken examples), analyze support tickets for top documentation failures, benchmark against competitor portal. Target state: unified developer portal (single source of truth), docs-as-code workflow (Git-based), automated quality checks, self-service onboarding, measurable developer satisfaction. Gap analysis: what exists vs what's needed, effort estimate for each gap. Risk assessment: team capacity, migration complexity, organizational change resistance"
36
+ weight: 0.35
37
+ description: "Assessment"
38
+ - type: llm_judge
39
+ criteria: "12-month plan with quarterly milestones is realistic — Q1 (foundation): migrate to docs-as-code, set up portal skeleton, write style guide, implement top-5 support-ticket-reducing guides, quick win: consolidate all docs to one URL. Q2 (content): complete API reference for all 150 endpoints, add interactive explorer, write quickstart guides for all 3 APIs, launch sandbox documentation. Q3 (quality): implement automated testing (contract tests, link checks, example validation), set up documentation metrics dashboard, launch feedback mechanism on every page. Q4 (maturity): multi-language code examples, partner documentation, documentation governance enforced across all teams, advanced guides. 30-day quick wins that show immediate value to build organizational buy-in"
40
+ weight: 0.35
41
+ description: "Execution plan"
42
+ - type: llm_judge
43
+ criteria: "Team, tooling, and metrics are concrete — team structure: 2 technical writers (one for content creation, one for developer experience/tooling), part-time contributions from each product team (documentation champion per team). Tooling budget: portal framework ($0 open-source — Docusaurus/Nextra), hosting (Vercel/Netlify, $200/month), search (Algolia DocSearch, free for open docs), analytics (Plausible, $100/month), testing (custom CI, minimal cost) — well under $200K. Remaining budget for: translation, design, external contractors for migration. Metrics: TTFC target <15 minutes, support ticket reduction tracked monthly, documentation satisfaction quarterly survey, documentation coverage (% endpoints with examples), automated health score. Success criteria clearly mapped to the 8/10 satisfaction and 70% ticket reduction targets"
44
+ weight: 0.30
45
+ description: "Team and metrics"
@@ -0,0 +1,46 @@
1
+ meta:
2
+ id: multi-audience-docs
3
+ level: 4
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Write for multiple audiences — create documentation that serves beginners, experienced developers, architects, and non-technical stakeholders from one source"
7
+ tags: [API, documentation, multi-audience, personas, content-strategy, expert]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ Your API documentation must serve radically different audiences:
13
+
14
+ 1. Junior developers: need hand-holding, explanations of REST concepts,
15
+ step-by-step tutorials
16
+ 2. Senior developers: want endpoint reference, skip to code examples,
17
+ hate reading obvious explanations
18
+ 3. Architects: need security model, rate limits, SLA, data residency,
19
+ compliance certifications
20
+ 4. Product managers: need capability overview, integration timeline
21
+ estimates, pricing implications
22
+ 5. Partner integrators: need everything above plus contractual SLA,
23
+ sandbox access, certification program
24
+
25
+ Currently your docs serve none of them well — too advanced for
26
+ juniors, too basic for seniors, missing architect info, impenetrable
27
+ for PMs.
28
+
29
+ Task: Design a multi-audience documentation strategy. Show how to
30
+ serve all five audiences from a single documentation system without
31
+ maintaining five separate doc sets. Include: content layering, persona
32
+ routing, progressive disclosure, and conditional content techniques.
33
+
34
+ assertions:
35
+ - type: llm_judge
36
+ criteria: "Content layering serves different expertise levels — progressive disclosure: start with simple explanation, expand for complexity. Pattern: summary (everyone reads) → quick start (beginners follow, seniors skip) → reference (seniors use) → deep dive (architects read). Implementation: collapsible sections ('Show advanced options'), tabbed content (beginner/advanced), difficulty indicators on pages. Landing page acts as router: 'I want to...' with persona-based paths. API reference: concise by default with expandable details (field descriptions, edge cases). Tutorial: clear 'Prerequisites' section so seniors skip what they know. Don't dumb down — layer up"
37
+ weight: 0.35
38
+ description: "Content layering"
39
+ - type: llm_judge
40
+ criteria: "Each audience gets what they need — junior developers: learning path (concepts → tutorials → reference), glossary of terms (what is idempotency?), copy-paste examples that work. Senior developers: search-first (find endpoint fast), curl examples, response schemas, skip to code. Architects: dedicated section — security whitepaper, compliance certifications (SOC2, HIPAA), architecture diagrams, SLA (99.9% uptime), data flow diagrams, disaster recovery, encryption at rest/in transit. Product managers: API capabilities overview (no code), integration effort estimates, use case galleries, pricing per API call. Partners: everything plus sandbox provisioning, certification program, co-branded documentation, dedicated support SLA"
41
+ weight: 0.35
42
+ description: "Audience-specific content"
43
+ - type: llm_judge
44
+ criteria: "Single-source strategy avoids content duplication — content reuse: write once, surface in multiple contexts (endpoint description appears in reference AND tutorial). Dynamic content: role-based content visibility (architect sees security section, developer sees code section) — implement with frontmatter tags and build-time filtering. Shared components: authentication section written once, embedded in every relevant guide. URL structure: /docs/reference/... (all audiences), /docs/guides/getting-started (beginners), /docs/architecture/security (architects), /docs/overview (PMs). Maintenance: single source in repo, build generates audience-specific views. Content model: each page has metadata (audience, difficulty, prerequisites) enabling smart navigation"
45
+ weight: 0.30
46
+ description: "Single-source strategy"
@@ -0,0 +1,44 @@
1
+ meta:
2
+ id: ai-powered-documentation
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Design AI-powered documentation — envision how AI transforms API documentation creation, maintenance, personalization, and developer interaction"
7
+ tags: [API, documentation, AI, LLM, automation, future, personalization, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ The CTO asks: "AI is changing everything. How will it change API
13
+ documentation? Should we invest in traditional docs or bet on AI?"
14
+
15
+ Current landscape:
16
+ - LLMs can generate documentation from code
17
+ - AI chatbots can answer developer questions from docs
18
+ - Code generation tools (Copilot) may reduce need for examples
19
+ - AI can translate docs to any language instantly
20
+ - But: AI hallucinations in technical docs are dangerous
21
+ - And: AI-generated docs often lack nuance and design decisions
22
+
23
+ Your company has 200 endpoints, 50K pages of documentation, and
24
+ 5,000 active developers.
25
+
26
+ Task: Write a strategic assessment of AI's impact on API documentation.
27
+ Include: what AI can automate today, what it can't, how to use AI
28
+ to enhance (not replace) documentation, risks and mitigations, and
29
+ a 3-year technology roadmap for AI-powered developer documentation.
30
+ Be honest about limitations — the CTO will see through hype.
31
+
32
+ assertions:
33
+ - type: llm_judge
34
+ criteria: "Assessment of AI capabilities is honest and specific — what AI can do today: (1) generate first-draft documentation from code and OpenAPI specs (70% quality, needs human review), (2) translate documentation across languages (good for technical content), (3) answer developer questions from existing docs (RAG-based chatbot), (4) detect documentation drift (compare docs to code), (5) generate code examples from endpoint descriptions. What AI cannot do well: (1) write design decision explanations (why, not what), (2) create meaningful tutorials (requires understanding developer journey), (3) maintain consistent voice and style across docs, (4) understand business context for error messages, (5) design information architecture. Honest assessment: AI is a force multiplier for writers, not a replacement. Removes 50% of toil, human focuses on remaining 50% of high-value content"
35
+ weight: 0.35
36
+ description: "Honest AI assessment"
37
+ - type: llm_judge
38
+ criteria: "AI enhancement strategy is practical — immediate wins: (1) AI documentation assistant chatbot — developer asks question, chatbot answers from docs with source citations, escalates to human when uncertain. (2) Automated drift detection — AI compares OpenAPI spec changes to documentation, flags outdated sections. (3) Code example generation — AI generates examples in multiple languages from curl templates. (4) Translation — AI translates docs to Japanese/Portuguese with human review for technical accuracy. Medium-term: (5) Personalized docs — AI adapts content to developer's skill level and language preference. (6) Smart search — semantic search that understands intent, not just keywords. (7) Automated API reference from code — generates and maintains reference docs with human oversight. Each initiative: implementation approach, expected impact, risk mitigation for hallucinations"
39
+ weight: 0.35
40
+ description: "Enhancement strategy"
41
+ - type: llm_judge
42
+ criteria: "Risks and 3-year roadmap are credible — risks: (1) hallucination — AI generates plausible but incorrect documentation (mitigation: always cite source, human review pipeline, automated testing against actual API). (2) Homogeneous voice — AI docs all sound the same (mitigation: style guide fine-tuning, human editors). (3) Over-reliance — team skills atrophy (mitigation: AI assists, doesn't replace). (4) Privacy — proprietary API designs exposed to AI providers (mitigation: self-hosted models, data boundaries). 3-year roadmap: Year 1 — chatbot + drift detection + translation (proven technologies, immediate value). Year 2 — personalized documentation + AI-generated examples + automated reference (emerging capabilities, measured rollout). Year 3 — intelligent documentation platform where docs learn from developer behavior and adapt (aspirational, depends on year 1-2 learnings). Budget: 20% of documentation budget allocated to AI tooling"
43
+ weight: 0.30
44
+ description: "Risks and roadmap"
@@ -0,0 +1,45 @@
1
+ meta:
2
+ id: api-first-documentation
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Document API-first strategy — write documentation that enables an API-first organizational transformation where APIs are products designed for external consumption"
7
+ tags: [API, documentation, api-first, design-first, organizational, transformation, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ Your company is transitioning to API-first: every capability must be
13
+ available as a well-documented API, not just internal microservices
14
+ with Swagger UI. This means:
15
+
16
+ - 40 internal APIs need to become "productized" (external-quality docs)
17
+ - API design happens before implementation (design-first)
18
+ - Documentation is part of the API definition, not an afterthought
19
+ - Every team must think about external developers as users
20
+
21
+ Resistance:
22
+ - "We don't have time to write docs for internal APIs"
23
+ - "Our APIs are too complex for external developers"
24
+ - "Documentation slows down development"
25
+ - "We'll document it when it's ready" (it's never ready)
26
+
27
+ Task: Write the API-first documentation playbook. Include: the
28
+ design-first documentation process, how to transform internal APIs
29
+ into externally documented products, team workflows that integrate
30
+ documentation into development, and organizational change management
31
+ for the "documentation is mandatory" mindset shift.
32
+
33
+ assertions:
34
+ - type: llm_judge
35
+ criteria: "Design-first process integrates documentation into development — workflow: (1) write API description (OpenAPI spec) before writing code, (2) review spec with stakeholders (including documentation quality), (3) generate mock server from spec for early feedback, (4) implement against the spec, (5) automated tests verify implementation matches spec, (6) documentation auto-generated from spec, (7) tech writer enhances with guides and tutorials. Documentation is a first-class artifact: just like tests, code cannot ship without documentation meeting quality bar. Definition of Done includes: OpenAPI spec complete, at least one example per endpoint, error codes documented, changelog entry written. API design review checklist includes documentation quality criteria"
36
+ weight: 0.35
37
+ description: "Design-first process"
38
+ - type: llm_judge
39
+ criteria: "Internal-to-external transformation is practical — assessment: score each internal API on 'external readiness' (documentation quality, naming consistency, error handling, authentication, rate limiting). Transformation tiers: Tier 1 (quick wins, 2 weeks): add descriptions to OpenAPI spec, add examples, standardize error format. Tier 2 (moderate, 1-2 months): implement consistent authentication, add rate limiting, write getting started guide, set up sandbox. Tier 3 (significant, 3-6 months): redesign API surface for external usability, comprehensive documentation, SDK generation, interactive explorer. Prioritization: transform APIs by business value (revenue potential × developer demand). Templates and checklists for each tier. Budget estimation framework: effort per API based on current state"
40
+ weight: 0.35
41
+ description: "Transformation playbook"
42
+ - type: llm_judge
43
+ criteria: "Change management addresses organizational resistance — address each objection: 'No time for docs' → documentation templates reduce effort to 30 minutes per endpoint, automated generation handles 60% of content. 'Too complex' → if developers can't understand it, the API design needs improvement (docs expose design problems). 'Slows development' → design-first actually speeds development (catch issues earlier, fewer integration bugs). 'We'll do it later' → documentation debt compounds like technical debt (quantify the cost). Incentive alignment: documentation quality in team performance metrics, API maturity scorecard visible to leadership, celebrate teams that achieve documentation excellence. Training program: documentation writing workshops, OpenAPI authoring training, peer mentorship (pair high-quality team with struggling team). Executive sponsorship: VP-level champion who holds teams accountable"
44
+ weight: 0.30
45
+ description: "Change management"
@@ -0,0 +1,42 @@
1
+ meta:
2
+ id: api-marketplace-docs
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Document API marketplace — create documentation standards and templates for an API marketplace where multiple providers list their APIs for discovery and integration"
7
+ tags: [API, documentation, marketplace, platform, multi-provider, standards, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ Your company is launching an API marketplace — a platform where
13
+ third-party providers list their APIs for developers to discover
14
+ and integrate. Think RapidAPI, AWS Marketplace, or Stripe Apps.
15
+
16
+ Challenges:
17
+ - 50 API providers with vastly different documentation quality
18
+ - Developers need to compare APIs (functionality, pricing, reliability)
19
+ - Each provider wants to maintain their own documentation style
20
+ - Need consistent discovery experience while respecting provider identity
21
+ - Quality control: how to ensure minimum documentation standard
22
+ - Cross-API workflows: developers combine multiple marketplace APIs
23
+
24
+ Task: Design the documentation framework for the API marketplace.
25
+ Include: provider onboarding documentation requirements, documentation
26
+ templates and standards, discovery and comparison features, cross-API
27
+ integration guides, and quality scoring that ranks providers by
28
+ documentation quality.
29
+
30
+ assertions:
31
+ - type: llm_judge
32
+ criteria: "Provider documentation standards ensure consistency — mandatory fields per listing: name, description (structured: what it does, who it's for, key features), OpenAPI 3.x spec, authentication method, pricing tiers, rate limits, SLA commitment, getting started guide (under 5 minutes). Standardized sections: Overview (templated), Authentication (templated), Endpoints (auto-generated from OpenAPI), Pricing (templated), Support (contact method, response time SLA). Template system: providers fill in structured templates — consistent presentation while allowing customization in descriptions and guides. Minimum quality gate: listing must score 70/100 on documentation quality rubric before going live. Provider documentation portal: where providers edit their listing with preview"
33
+ weight: 0.35
34
+ description: "Provider standards"
35
+ - type: llm_judge
36
+ criteria: "Discovery and comparison features help developers choose — category taxonomy: organized by function (payments, communications, data, AI/ML) with sub-categories. Comparison table: side-by-side view of up to 3 APIs showing features, pricing, rate limits, authentication method, SDK languages supported, documentation quality score. Search: full-text search across all API documentation, filter by category, authentication type, pricing model, language support. Developer reviews and ratings: per-provider DX rating (documentation quality, support responsiveness, reliability). 'Similar APIs' recommendations. Use case pages: 'Building an e-commerce platform? You'll need these APIs' — curated bundles. Playground: try any marketplace API directly from the listing page"
37
+ weight: 0.35
38
+ description: "Discovery features"
39
+ - type: llm_judge
40
+ criteria: "Cross-API documentation and quality scoring are strategic — cross-API integration guides: common workflows combining multiple marketplace APIs (e.g., 'Accept payments + send receipts: Payments API + Email API'). Unified authentication: marketplace SDK handles auth for all providers (one token, multiple APIs). Quality scoring rubric: documentation completeness (25%), accuracy (examples work) (25%), developer feedback (25%), maintenance (updated within 30 days of API changes) (25%). Score displayed on listing page — providers compete on documentation quality. Incentives: top-rated providers get featured placement, lower marketplace fees. Provider leaderboard: public ranking of documentation quality. Marketplace-level documentation: how to use the marketplace itself, unified SDK guide, billing documentation, support escalation paths"
41
+ weight: 0.30
42
+ description: "Cross-API and quality"
@@ -0,0 +1,48 @@
1
+ meta:
2
+ id: board-api-strategy
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Present API strategy to the board — translate technical API documentation investments into board-level business language covering ROI, competitive positioning, and growth enablement"
7
+ tags: [API, documentation, board-presentation, ROI, business-strategy, executive, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ The board meeting is next week. You need to present the case for
13
+ a $2M investment in developer documentation over the next 2 years.
14
+ Board members are not technical — they understand revenue, market
15
+ share, competitive positioning, and customer acquisition.
16
+
17
+ What they'll ask:
18
+ - "Why does documentation need $2M? Can't we just use AI to write it?"
19
+ - "What's the ROI? When do we see returns?"
20
+ - "Our competitor spends less on docs — why should we spend more?"
21
+ - "How does this compare to investing $2M in more sales reps?"
22
+ - "What happens if we don't invest in documentation?"
23
+
24
+ Data available:
25
+ - Current: 5,000 integrations, $50M ARR, 3.5% monthly churn
26
+ - Developer acquisition cost (DAC): $2,500 per integration
27
+ - Support cost: $50 per ticket, 3,000 doc-related tickets/year ($150K)
28
+ - Competitor A: invested $3M in docs, grew integrations 3x in 2 years
29
+ - Developer survey: 40% cite "documentation quality" in churn reasons
30
+
31
+ Task: Write the board presentation talking points. Include: executive
32
+ summary, investment case with financial model, competitive analysis,
33
+ risk of inaction, and comparison to alternative investments (sales
34
+ reps vs documentation).
35
+
36
+ assertions:
37
+ - type: llm_judge
38
+ criteria: "Executive summary speaks business language — no technical jargon. Key message: documentation is customer acquisition infrastructure, not a cost center. Headlines: (1) documentation quality drives 40% of developer churn — fixing it protects $20M ARR at risk, (2) better documentation reduces developer acquisition cost from $2,500 to $800, (3) Competitor A's documentation investment correlated with 3x integration growth, (4) $2M investment projected to generate $15M incremental ARR over 2 years (7.5x ROI). Framing: this is not 'writing help pages' — this is building the customer onboarding and retention infrastructure that the developer business model requires. One-page summary with financials that a non-technical board member can absorb in 2 minutes"
39
+ weight: 0.35
40
+ description: "Executive summary"
41
+ - type: llm_judge
42
+ criteria: "Financial model is rigorous — investment: Year 1 $1M (team expansion, portal build, content creation), Year 2 $1M (continued content, internationalization, AI tools). Returns model: (1) Churn reduction: improving docs addresses 40% of churn, reducing monthly churn from 3.5% to 2.5% retains $5M additional ARR annually. (2) Acquisition efficiency: self-service documentation reduces DAC from $2,500 to $800, same sales budget onboards 3x more developers. (3) Support savings: reducing doc-related tickets by 70% saves $105K/year. (4) Conversion improvement: TTFC reduction from 5 days to 4 hours increases trial conversion by X%. Total 2-year impact: $15M+ incremental ARR. Payback period: under 12 months. Sensitivity analysis: even at 50% of projected impact, ROI exceeds 3x"
43
+ weight: 0.35
44
+ description: "Financial model"
45
+ - type: llm_judge
46
+ criteria: "Risk analysis and alternatives comparison are compelling — risk of inaction: 40% churn factor worsens as competitor docs improve, developer expectations rise annually, $20M ARR at risk over 2 years. Competitor comparison: Competitor A spent $3M and grew 3x — we're proposing $2M for similar trajectory. Alternative comparison: $2M in sales reps = 8 reps × $250K = ~800 new integrations at $2,500 DAC. $2M in documentation = infrastructure that supports unlimited onboarding at $800 DAC — scales better, compounds over time. Documentation is leverage on every other growth investment (marketing, sales, partnerships all benefit). AI and documentation: AI helps write and maintain docs (reducing cost) but doesn't replace strategy, design, or developer empathy. Timeline with decision urgency: every quarter delayed is $X in continued churn"
47
+ weight: 0.30
48
+ description: "Risk and alternatives"
@@ -0,0 +1,42 @@
1
+ meta:
2
+ id: documentation-program-strategy
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Design documentation program strategy — create a multi-year documentation program vision connecting developer experience to business outcomes across an API-first organization"
7
+ tags: [API, documentation, program-strategy, vision, business-outcomes, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ You're the VP of Developer Relations at an API-first company doing
13
+ $50M ARR. The board wants a 3-year strategy for the developer
14
+ documentation program. Context:
15
+
16
+ - 5,000 active integrations across 3 API products
17
+ - Developer ecosystem is the primary growth engine (80% of revenue)
18
+ - Current documentation team: 4 technical writers, 1 DX engineer
19
+ - Annual documentation budget: $800K (salaries + tooling)
20
+ - Competitor analysis: Stripe and Twilio set the standard — your docs
21
+ are rated "adequate" by developers
22
+ - Board goal: reach 15,000 integrations and $150M ARR in 3 years
23
+
24
+ Task: Present the 3-year documentation program strategy to the board.
25
+ Include: vision statement, year-by-year roadmap, team growth plan,
26
+ technology investments, competitive positioning, and how documentation
27
+ directly contributes to the $150M ARR target. Quantify the business
28
+ impact of every major initiative.
29
+
30
+ assertions:
31
+ - type: llm_judge
32
+ criteria: "Vision connects documentation to revenue growth — clear thesis: documentation quality directly drives integration velocity, which drives revenue. Data: current TTFC of X days, each day reduced increases trial-to-paid conversion by Y%. Developer ecosystem economics: each integration generates $10K ARR average, reaching 15,000 integrations requires 10,000 new integrations in 3 years, documentation must support onboarding 300+ integrations/month vs current 100/month. Vision: evolve from 'documentation' to 'developer education platform' — not just reference docs but learning paths, certification, community-generated content. Competitive positioning: match Stripe quality in year 1, differentiate with AI-powered personalized documentation in year 2-3"
33
+ weight: 0.35
34
+ description: "Vision and revenue link"
35
+ - type: llm_judge
36
+ criteria: "Year-by-year roadmap is detailed and measurable — Year 1 (Foundation → Excellence): hire 2 more writers + 1 DX engineer, launch unified developer portal, implement docs-as-code, achieve Stripe-quality API reference, interactive explorer, 3 quickstart tutorials, automated testing. KPIs: TTFC from 5 days to 1 day, satisfaction from 6/10 to 8/10. Investment: $400K additional. Year 2 (Differentiation): multi-language docs (Japanese, Portuguese), SDK documentation for 6 languages, partner certification program, AI-powered search and recommendations, community contributions platform. KPIs: international integrations +200%, partner onboarding time -75%. Year 3 (Platform): developer education platform with courses, certification program generating revenue, AI documentation assistant (answers developer questions from docs), predictive documentation (auto-generate docs from code changes). Each initiative has estimated revenue impact"
37
+ weight: 0.35
38
+ description: "Roadmap"
39
+ - type: llm_judge
40
+ criteria: "Investment case and team plan are board-ready — total 3-year investment: $X (broken down by year, by category: people, tooling, content). ROI model: documentation investment → reduced TTFC → higher conversion → more integrations → more revenue. Specific calculations: reducing TTFC by 1 day increases conversion by X% = Y additional integrations × $10K ARR = $Z revenue. Support cost savings: reducing doc-related tickets by Z% saves $W/year. Team growth: Year 1 (7 people), Year 2 (10 people), Year 3 (12 people) — roles defined (writers, DX engineers, community manager, documentation PM). Technology investments justified: portal ($X, enables self-service), testing ($Y, prevents regression), AI ($Z, scales support). Risk mitigation: what if the investment doesn't hit targets — leading indicators to track quarterly, pivot strategies"
41
+ weight: 0.30
42
+ description: "Investment case"
@@ -0,0 +1,47 @@
1
+ meta:
2
+ id: documentation-team-structure
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Design documentation team structure — define roles, responsibilities, career paths, and organizational placement for a developer documentation team at scale"
7
+ tags: [API, documentation, team-structure, hiring, career-path, organization, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ You're scaling from 2 technical writers to a 15-person documentation
13
+ team. You need to design the organizational structure from scratch:
14
+
15
+ Current state:
16
+ - 2 technical writers embedded in engineering (overwhelmed)
17
+ - 5 engineering teams with 15 APIs
18
+ - Growing from 5,000 to 20,000 integrations over 3 years
19
+ - Documentation quality varies wildly by product team
20
+ - No career path for technical writers (they all leave after 2 years)
21
+
22
+ Decisions to make:
23
+ - Centralized documentation team vs embedded per product team?
24
+ - What roles beyond "technical writer" are needed?
25
+ - Where does documentation report? Engineering? Product? Marketing?
26
+ - How do you hire for API documentation specifically?
27
+ - What does a career ladder look like?
28
+
29
+ Task: Design the complete documentation team structure. Include:
30
+ organizational model, role definitions, hiring profiles, career
31
+ ladder, and the collaboration model with engineering and product
32
+ teams. Address retention by making the team a place where people
33
+ build meaningful careers.
34
+
35
+ assertions:
36
+ - type: llm_judge
37
+ criteria: "Organizational model balances consistency and responsiveness — recommend hybrid model: centralized documentation team for standards, tooling, and platform — with embedded 'documentation engineers' allocated to product teams for deep domain knowledge. Reporting: documentation team reports to VP of Developer Experience (not Engineering or Marketing — needs independence). Team structure: Director of Documentation → 3 pods: (1) Content (writers producing docs), (2) Platform (DX engineers building portal, tools, CI/CD), (3) Standards (style guide, quality, governance). Pod leads have management responsibilities. Cross-functional rituals: weekly sync with product teams, quarterly planning aligned with product roadmap. Justify why embedded-only fails (inconsistency) and centralized-only fails (slow, disconnected)"
38
+ weight: 0.35
39
+ description: "Organizational model"
40
+ - type: llm_judge
41
+ criteria: "Roles are differentiated beyond 'technical writer' — roles defined: (1) API Technical Writer: writes reference docs, guides, tutorials — strong writing + basic coding. (2) Documentation Engineer: builds documentation tooling, CI/CD, automated testing — strong coding + adequate writing. (3) Developer Experience Designer: designs information architecture, user journeys, portal UX — design + developer empathy. (4) Developer Educator: creates tutorials, videos, workshops — teaching + technical depth. (5) Documentation Program Manager: cross-team coordination, metrics, governance — project management + technical understanding. (6) Director of Documentation: strategy, team leadership, budget, executive communication. Hiring profiles: for API doc writers, prioritize candidates who have shipped code (bootcamp grad who learned to write > English major who learned to code). Interview process: writing sample with API context, pair writing session, technical assessment"
42
+ weight: 0.35
43
+ description: "Roles and hiring"
44
+ - type: llm_judge
45
+ criteria: "Career ladder and retention strategy are compelling — career levels: Junior Writer (L1) → Technical Writer (L2) → Senior Writer (L3) → Staff Writer (L4) → Principal Writer (L5). Parallel management track: Lead → Manager → Senior Manager → Director. Each level: clear expectations for scope, quality, impact, and independence. L1: write docs from detailed outlines. L3: own documentation for entire product, influence API design. L5: set documentation strategy across the organization. Growth opportunities: specialize (API design, developer education, tooling) or generalize (management, strategy). Retention strategies: competitive compensation benchmarked against software engineers (not content writers), conference speaking opportunities, open-source contribution time, documentation innovation projects (AI tools, interactive docs). Address why writers leave: no career growth (ladder fixes this), undervalued (executive reporting and metrics fix this), isolated (team structure and community fix this)"
46
+ weight: 0.30
47
+ description: "Career ladder"
@@ -0,0 +1,46 @@
1
+ meta:
2
+ id: dx-competitive-advantage
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Position developer experience as competitive advantage — articulate how superior API documentation creates defensible competitive moats and drives market leadership"
7
+ tags: [API, documentation, developer-experience, competitive-advantage, moat, strategy, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ Your API competes in a commoditized market — three competitors offer
13
+ nearly identical functionality at similar prices. The differentiation
14
+ is developer experience:
15
+
16
+ - Competitor A: best docs, 40% market share, highest developer love
17
+ - Competitor B: cheapest, 35% market share, "good enough" docs
18
+ - You: 25% market share, technically superior API but poor DX
19
+
20
+ Board question: "We have the best technology but are losing to
21
+ Competitor A. Their developers love them. How do we win developers?"
22
+
23
+ Evidence that DX matters:
24
+ - 73% of developers say documentation quality influences API choice
25
+ - Switching cost for APIs is low — developers migrate in weeks
26
+ - Developer advocacy drives organic growth (word of mouth)
27
+ - Best-documented APIs command 20-30% price premium
28
+
29
+ Task: Present a strategy to make developer experience your primary
30
+ competitive differentiator. Include: competitive analysis framework,
31
+ DX improvement roadmap, measurement methodology, and how to build
32
+ a developer community that becomes a growth engine.
33
+
34
+ assertions:
35
+ - type: llm_judge
36
+ criteria: "Competitive analysis is data-driven — framework for evaluating DX: (1) time to first API call, (2) time to production integration, (3) documentation completeness and accuracy, (4) error message helpfulness, (5) SDK quality, (6) community and support responsiveness, (7) developer satisfaction (NPS). Benchmark against Competitor A on each dimension with specific scores. Identify DX gaps: where are developers struggling more with your API than Competitor A? Developer journey mapping: compare end-to-end experience (discovery → evaluation → integration → production → growth). Win/loss analysis: interview developers who chose Competitor A — what specifically drove their decision? Quantify: each DX improvement point translates to X% market share shift"
37
+ weight: 0.35
38
+ description: "Competitive analysis"
39
+ - type: llm_judge
40
+ criteria: "DX improvement roadmap creates measurable differentiation — phased approach: Phase 1 (parity, 0-6 months): match Competitor A's documentation quality, reduce TTFC to industry best, fix top 10 developer pain points. Phase 2 (differentiation, 6-18 months): interactive tutorials, personalized onboarding paths, AI-powered documentation search, multi-language support, community-generated examples. Phase 3 (leadership, 18-36 months): developer education platform, certification program, API design toolkit for customers building on your platform, developer conference. Each phase has measurable DX metrics with targets. Quick wins: identify 5 things Competitor A does poorly — leapfrog on those immediately. Investment required per phase with expected market share impact"
41
+ weight: 0.35
42
+ description: "DX roadmap"
43
+ - type: llm_judge
44
+ criteria: "Community strategy creates sustainable growth moat — developer community as growth engine: developer advocates → content creation → organic discovery → new developers. Community program: Stack Overflow presence, GitHub open-source tools, developer blog with technical content, conference talks, local meetups. User-generated content: community-maintained code examples, integration guides, tutorials — scales documentation beyond your team. Developer champions program: identify and empower your most active developers with early access, swag, speaking opportunities. Measurement: community-influenced signups (developers who engaged with community before signing up), community content views, Net Promoter Score trend. Moat: strong developer community is hard for competitors to replicate — it takes years to build trust and relationships. Economic model: community reduces CAC (customer acquisition cost) and increases retention"
45
+ weight: 0.30
46
+ description: "Community strategy"
@@ -0,0 +1,45 @@
1
+ meta:
2
+ id: ecosystem-documentation
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Document developer ecosystem — create documentation strategy for a platform ecosystem including APIs, SDKs, plugins, integrations, and community-built extensions"
7
+ tags: [API, documentation, ecosystem, platform, extensions, plugins, community, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ Your platform has evolved into an ecosystem:
13
+
14
+ - Core APIs: 3 products (payments, billing, identity) — 200 endpoints
15
+ - SDKs: 6 languages (Python, Node.js, Go, Java, Ruby, PHP)
16
+ - Plugins: 30 official integrations (Shopify, WordPress, Salesforce...)
17
+ - Extensions: 200 community-built extensions in a marketplace
18
+ - Webhooks: 50 event types across all products
19
+ - CLI tool for developer workflows
20
+ - Terraform provider for infrastructure-as-code
21
+
22
+ Documentation challenge: interconnected systems where changes cascade.
23
+ A payments API update affects SDKs, plugins, extensions, and guides
24
+ simultaneously. No one person understands the full documentation
25
+ surface area.
26
+
27
+ Task: Design the documentation strategy for the entire ecosystem.
28
+ Include: content architecture for interconnected products, cross-
29
+ product documentation (how products work together), contributor
30
+ documentation for community extension builders, and a coordination
31
+ model for keeping everything in sync when core APIs change.
32
+
33
+ assertions:
34
+ - type: llm_judge
35
+ criteria: "Ecosystem architecture manages complexity — content hierarchy: platform overview (how products relate) → product docs (per-product deep dive) → SDK docs (per-language) → integration docs (per-platform) → extension docs (community). Cross-referencing: every product page links to related products, relevant SDKs, and applicable integrations. Unified navigation: single search across all documentation, consistent sidebar, breadcrumbs showing product > section > page. Information architecture: developer-centric (task-based: 'Accept a payment') not organization-centric (product team structure). Shared components: authentication, error handling, pagination documented once, referenced everywhere. Monorepo vs multi-repo documentation strategy with justification"
36
+ weight: 0.35
37
+ description: "Ecosystem architecture"
38
+ - type: llm_judge
39
+ criteria: "Cross-product and extension documentation enable the ecosystem — cross-product guides: 'Accept payment and auto-generate invoice' (payments + billing), 'Authenticate user and create customer' (identity + payments). These guides are the highest-value content — they show the ecosystem advantage. Extension builder documentation: API reference for extension points, plugin development guide (scaffolding, testing, publishing), code review requirements, marketplace listing guidelines, versioning policy for extension APIs. Community documentation: contributor guide, documentation style guide for extension authors, templates for extension docs, quality review process. Extension documentation is part of the marketplace listing"
40
+ weight: 0.35
41
+ description: "Cross-product and extensions"
42
+ - type: llm_judge
43
+ criteria: "Coordination model keeps ecosystem docs in sync — change propagation: when core API changes, automated system identifies affected: SDKs (which methods use this endpoint), plugins (which integrations call this), guides (which tutorials reference this), extensions (which extension APIs are impacted). Notification: affected teams/maintainers notified with specific impact. SDK update automation: OpenAPI spec change triggers SDK regeneration and doc update. Plugin compatibility matrix: table showing which plugin versions work with which API versions. Community notification: breaking changes announced in developer forum, extension authors notified via email. Documentation ownership model: core team owns product docs, SDK teams own SDK docs, integration team owns plugin docs, community owns extension docs — with platform team providing templates and quality oversight. Quarterly ecosystem documentation review: cross-team sync on upcoming changes"
44
+ weight: 0.30
45
+ description: "Coordination model"
@@ -0,0 +1,46 @@
1
+ meta:
2
+ id: industry-documentation-patterns
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Analyze industry documentation patterns — evaluate and synthesize documentation best practices from leading API companies to define next-generation documentation standards"
7
+ tags: [API, documentation, industry-patterns, best-practices, benchmarking, standards, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ You're writing a keynote talk for a developer relations conference:
13
+ "The Future of API Documentation." You need to analyze what the best
14
+ API companies do, identify patterns, and articulate where the industry
15
+ is heading.
16
+
17
+ Companies to analyze:
18
+ - Stripe: gold standard for API docs, interactive examples
19
+ - Twilio: code-first documentation, multi-language examples
20
+ - GitHub: massive API surface, excellent guides alongside reference
21
+ - Cloudflare: developer-friendly docs for complex infrastructure
22
+ - Plaid: security-sensitive API with excellent onboarding
23
+ - OpenAI: rapidly evolving API with streaming and novel patterns
24
+
25
+ Each has solved different documentation challenges. The audience
26
+ wants actionable insights they can apply to their own APIs.
27
+
28
+ Task: Write the keynote content analyzing documentation patterns
29
+ across these companies. Identify: common patterns (what they all do),
30
+ differentiating innovations (unique approaches), emerging trends,
31
+ and a framework for evaluating and improving API documentation
32
+ that any company can apply.
33
+
34
+ assertions:
35
+ - type: llm_judge
36
+ criteria: "Analysis identifies common patterns across leaders — patterns every great API doc has: (1) time-to-first-call under 5 minutes (all have quickstart), (2) interactive code examples (not just static snippets), (3) consistent error documentation (every error explained), (4) authentication documented with copy-paste examples, (5) changelog with structured change categories, (6) sandbox/test mode prominently featured, (7) search that works (semantic, not just keyword). Anti-patterns found in poor docs: auto-generated Swagger with no descriptions, examples with placeholder data (foo, bar, 123), inconsistent formatting, no getting started guide. Framework: score any API documentation on these patterns (1-5 per dimension) for quick assessment"
37
+ weight: 0.35
38
+ description: "Common patterns"
39
+ - type: llm_judge
40
+ criteria: "Company-specific innovations are insightful — Stripe: progressive disclosure (simple by default, expandable for complexity), right-sidebar code examples that update when toggling languages, inline 'test mode' toggle. Twilio: code-first approach (show code before explaining concepts), helper libraries for every language, 'TwiML' documentation as domain-specific language docs. GitHub: massive reference managed through automated tooling, 'Getting started' guides for common workflows, GraphQL + REST documentation coexistence. Cloudflare: infrastructure docs that explain concepts before API calls, Wrangler CLI docs integrated with API docs. Plaid: Link (pre-built UI) documentation alongside raw API, security-conscious docs (never show real credentials, even in examples). OpenAI: streaming API documentation, novel patterns (tool use, function calling) requiring new documentation paradigms. Each insight is specific enough to be actionable"
41
+ weight: 0.35
42
+ description: "Company innovations"
43
+ - type: llm_judge
44
+ criteria: "Emerging trends and evaluation framework are forward-looking — trends: (1) AI-assisted documentation (chatbots answering API questions, AI-generated examples), (2) personalized documentation (adapt to developer's language, framework, skill level), (3) video and interactive tutorials alongside text, (4) documentation as part of the product (not separate site), (5) community-contributed documentation at scale, (6) API documentation for AI consumers (not just human developers — how do LLMs read your docs?). Evaluation framework: 5 dimensions — Discoverability (can developers find what they need?), Completeness (is everything documented?), Accuracy (do examples work?), Usability (can a new developer integrate in 30 minutes?), Maintenance (are docs kept current?). Each dimension: 5-point rubric with specific criteria. Framework applicable to any API, any size company. Action items: top 3 things any company can do this quarter to improve their docs"
45
+ weight: 0.30
46
+ description: "Trends and framework"
@@ -0,0 +1,46 @@
1
+ meta:
2
+ id: master-documentation-shift
3
+ level: 5
4
+ course: api-documentation-writing
5
+ type: output
6
+ description: "Combined master shift — present a complete API documentation transformation strategy for an enterprise acquiring a developer platform company, unifying two documentation ecosystems"
7
+ tags: [API, documentation, combined, shift-simulation, M&A, transformation, master]
8
+
9
+ state: {}
10
+
11
+ trigger: |
12
+ Your enterprise (FinCorp, $500M revenue, traditional financial services)
13
+ just acquired a developer platform startup (DevPay, $30M ARR, 8,000
14
+ integrations, beloved by developers). You're now responsible for unifying
15
+ the documentation strategy.
16
+
17
+ The situation:
18
+ - FinCorp: enterprise docs (PDFs, Confluence), SOAP APIs, no developer portal
19
+ - DevPay: beautiful developer portal, REST APIs, OpenAPI specs, community
20
+ - FinCorp developers: banks and large enterprises, expect formal docs
21
+ - DevPay developers: startups and indie devs, expect Stripe-quality DX
22
+ - Goal: unified platform offering both enterprise and developer APIs
23
+ - Risk: DevPay developers leave if documentation quality degrades
24
+ - Opportunity: FinCorp's 500 enterprise clients gain modern API access
25
+
26
+ Timeline: 18 months to unified platform. Board is watching.
27
+
28
+ Task: Present the complete M&A documentation strategy. Cover:
29
+ assessment of both documentation estates, unified platform vision,
30
+ migration plan preserving DevPay's DX quality while adding FinCorp's
31
+ enterprise requirements, team integration, technology consolidation,
32
+ and risk mitigation. This is a board-level strategy document.
33
+
34
+ assertions:
35
+ - type: llm_judge
36
+ criteria: "Assessment and vision bridge two worlds — dual assessment: DevPay docs (strengths: interactive explorer, modern portal, community, developer love. Gaps: no enterprise compliance docs, no SOAP). FinCorp docs (strengths: compliance documentation, enterprise onboarding. Gaps: no developer portal, outdated tech, terrible DX). Unified vision: 'One platform, two experiences' — modern developer portal (DevPay standard) with enterprise documentation layer (compliance, SLA, security whitepapers). Not: force FinCorp enterprise style on DevPay developers. Not: ignore enterprise requirements. Technology: adopt DevPay's portal as foundation, add enterprise features. Brand: unified brand with clear signposting for enterprise vs developer audiences"
37
+ weight: 0.35
38
+ description: "Assessment and vision"
39
+ - type: llm_judge
40
+ criteria: "Migration plan preserves what works — phase 1 (months 1-6): protect DevPay DX (do not change anything DevPay developers currently use), add FinCorp APIs to DevPay portal with proper documentation, begin migrating FinCorp enterprise docs to modern format. Phase 2 (months 7-12): unified authentication documentation, cross-product guides (FinCorp + DevPay), enterprise compliance section added to portal, SOAP-to-REST migration guides for FinCorp customers. Phase 3 (months 13-18): fully unified portal, deprecated legacy FinCorp docs, community migrated, enterprise customers onboarded. Key risk: DevPay developer churn during transition — mitigation: DevPay documentation team retains autonomy during phase 1, changes are additive only, developer advisory board provides feedback before any changes. Success metric: DevPay NPS stays above 50 throughout transition"
41
+ weight: 0.35
42
+ description: "Migration plan"
43
+ - type: llm_judge
44
+ criteria: "Team integration and board communication are strategic — team structure: DevPay documentation team leads unified team (they have the skills), FinCorp technical writers retrained on modern tools (docs-as-code, OpenAPI, portal). Org chart: combined team of 12 under Head of Developer Documentation (hire from DevPay or external). Training: 3-month ramp for FinCorp writers on DevPay tools and standards. Attrition plan: expected to lose some writers during transition — pre-identified backfill candidates. Board communication: quarterly progress report with metrics — developer satisfaction (both audiences), documentation coverage, migration percentage complete, developer churn rate. Budget: $1.5M over 18 months (team, tooling, migration). Risk register: top 5 risks with mitigations (DevPay developer churn, FinCorp enterprise customer confusion, team culture clash, technical debt, timeline slip). Success criteria: unified portal live, both audiences satisfied (NPS > 40), zero documentation-related churn"
45
+ weight: 0.30
46
+ description: "Team and board"
@@ -0,0 +1,12 @@
1
+ id: code-review-feedback-writing
2
+ name: "Code Review Feedback Writing"
3
+ description: >
4
+ Master code review feedback writing from clear inline comments and
5
+ constructive tone to organizational review culture design and
6
+ engineering quality strategy. Progress through giving actionable
7
+ feedback, reviewing complex changes across domains, mentoring
8
+ through reviews, optimizing review processes, and building review
9
+ cultures that accelerate engineering organizations.
10
+ levels: 5
11
+ scenarios_per_level: 10
12
+ tags: [writing, code-review, feedback, engineering, collaboration, mentoring, quality]