ln-323-manual-creator

Package API Reference Manual Creation Workflow

Linear Workflow for creating minimal API reference manuals through automated research. 4 phases: Research (auto via MCP) → Analysis → Generation → Confirmation.

Color Coding

Discovery/Research (Phase 0)
Processing (Phase 1-2)
Decision (Phase 3)
Action (Save)
graph TD Start([Start: Package + Version]) --> Phase0[Phase 0: Research & Discovery
AUTO 10-15 min] Phase0 --> Context7[Context7: Library API Docs
resolve-library-id + get-library-docs] Phase0 --> MCPRef[MCP Ref: Official Docs
API reference search] Context7 --> Extract[Extract Method Signatures
Parameters, Return Types] MCPRef --> Extract Extract --> Phase1[Phase 1: Method Analysis
Parse signatures, Generate tables] Phase1 --> ParseSig[Parse Method Signatures] ParseSig --> ParamTable[Generate Parameter Tables
name | type | required | default | description] ParamTable --> Examples[Extract Usage Examples] Examples --> Phase2[Phase 2: Manual Generation
Copy template + Edit placeholders] Phase2 --> CopyTemplate[Copy manual_template.md] CopyTemplate --> Replace[Replace Placeholders
PACKAGE, VERSION, METHODS] Replace --> GenMethods[Generate Methods Sections
For each method: signature + params + example] GenMethods --> Validate{Validation
SCOPE tags?
Neutral tone?
All params documented?} Validate -->|Pass| Preview[Show Preview
Package | Version | Methods | Length] Validate -->|Fail| Fix[Fix Issues] Fix --> Validate Preview --> Phase3{Phase 3: User Confirmation
Type 'confirm'?} Phase3 -->|No| Preview Phase3 -->|Yes| Save[Save Manual
docs/manuals/package-version.md] Save --> Return[Return File Path
For linking in tasks/stories] Return --> End([End]) classDef discovery fill:#4A90E2,stroke:#2E5C8A,color:#fff classDef processing fill:#FDB45C,stroke:#E09A3E,color:#333 classDef decision fill:#F7931E,stroke:#C87016,color:#fff classDef action fill:#46BFBD,stroke:#2E8B8B,color:#fff class Phase0,Context7,MCPRef,Extract discovery class Phase1,ParseSig,ParamTable,Examples,Phase2,CopyTemplate,Replace,GenMethods,Validate,Fix,Preview processing class Phase3 decision class Save,Return action

Workflow Phases

Phase 0: Research & Discovery (10-15 min, Automated)

  • Context7: resolve-library-id("[package]") → get-library-docs(library_id, topic="methods")
  • MCP Ref: "[package] v[version] API reference" search
  • Extract: Method signatures, parameters, return types, exceptions, usage examples
  • Output: Package metadata + method list + sources (2-3 official docs)

Phase 1: Method Analysis

  • Parse Signatures: Method names, parameter lists, return types
  • Generate Tables: Parameters table (name | type | required | default | description)
  • Extract Examples: Representative usage examples from official docs

Phase 2: Manual Generation

  • Copy Template: references/manual_template.md
  • Replace Placeholders: {{PACKAGE_NAME}}, {{VERSION}}, {{METHODS}}, etc.
  • Generate Methods Sections: For each method: signature + description + parameters table + returns + raises + example
  • Validation: SCOPE tags, neutral tone, all params documented, official docs linked
  • Show Preview: Package | Version | Methods count | Word count

Phase 3: Confirmation & Storage

  • User Confirmation: Wait for "confirm" input
  • Save Manual: docs/manuals/[package]-[version].md (NO sequential numbering)
  • Return Path: File path for linking in tasks/stories

Key Characteristics

When to Use

Document Type Focus When to Create
Guide (ln-321-guide-creator) HOW to implement (patterns, best practices) Auto-invoked by ln-320-story-validator (ad-hoc)
ADR (ln-322-adr-creator) WHY we decided (alternatives, consequences) Manual (during architecture phase, rare)
Manual (ln-323-manual-creator) WHAT API can do (methods, parameters, examples) Manual (after Story Done, optional)