documentation

name	documentation
description	Developer documentation including API references, guides, and getting started content
sasmp_version	1.4.0
version	2.0.0
updated	2025-01
bonded_agent	04-technical-writer
bond_type	PRIMARY_BOND

Developer Documentation

Create comprehensive, usable documentation that helps developers succeed.

Skill Contract

Parameters

parameters:
  required:
    - doc_type: enum[quickstart, tutorial, howto, concept, reference]
    - product_area: string
  optional:
    - api_spec: object
    - target_ttfhw: duration

Output

output:
  documentation:
    content: markdown
    code_samples: array[CodeBlock]
    navigation: object

Documentation Types

Type	Purpose	Example
Quickstart	First 5 minutes	"Hello World in 5 min"
Tutorial	Learn by doing	"Build your first app"
How-to	Solve specific task	"How to authenticate"
Concept	Understand system	"How caching works"
Reference	Look up details	"API endpoint list"

Information Architecture

Docs Site
├── Getting Started
│   ├── Quickstart
│   ├── Installation
│   └── First API Call
├── Guides
│   ├── Authentication
│   ├── Error Handling
│   └── Best Practices
├── API Reference
│   ├── Endpoints
│   ├── Parameters
│   └── Response Codes
└── Resources
    ├── FAQ
    ├── Changelog
    └── Migration Guides

Writing Standards

Structure Every Page

# Page Title

Brief intro (what this covers, who it's for)

## Prerequisites
What they need before starting

## Main Content
Step-by-step or organized sections

## Next Steps
What to do after this

Code Samples

• Complete, working examples
• Multiple language options
• Copy button on code blocks
• Show expected output

Docs-as-Code

Write (MD) → Review (PR) → Build (CI) → Deploy (CD)
    ↓          ↓            ↓            ↓
  Local     GitHub       Docusaurus   Vercel

Retry Logic

retry_patterns:
  outdated_content:
    strategy: "Sync with latest API version"

  user_confusion:
    strategy: "Add examples, clarify language"

  broken_code_samples:
    strategy: "Test in CI, fix immediately"

Failure Modes & Recovery

Failure Mode	Detection	Recovery
Outdated	API changed	Update with deprecation
Broken links	404 errors	Fix or redirect
User can't complete	Feedback	Add missing steps

Debug Checklist

□ All code samples tested?
□ Prerequisites complete?
□ Links working?
□ Version numbers specified?
□ Screenshots current?
□ Follows style guide?

Test Template

test_documentation:
  unit_tests:
    - test_code_samples:
        assert: "All code runs"
    - test_links:
        assert: "No 404s"

  integration_tests:
    - test_ttfhw:
        assert: "<10 min to first success"

Quality Metrics

Metric	Target
Time to first success	<10 min
Doc search success	>80%
Ticket deflection	60%+
User satisfaction	>4.0/5

Observability

metrics:
  - pages_updated: integer
  - code_samples_tested: integer
  - user_satisfaction: float
  - search_success_rate: float

See assets/ for documentation templates.