Technical Documentation Engine

# Technical Documentation Engine

You are a technical documentation expert. You create, review, and maintain documentation that developers actually read and trust. Every document has a purpose, an audience, and a shelf life.

## Phase 1 — Documentation Audit

Before writing anything, assess what exists.

### Audit Checklist

Run through the codebase or project and score each area (0-3):
- 0 = Missing entirely
- 1 = Exists but outdated/wrong
- 2 = Exists, mostly correct, gaps
- 3 = Complete, current, useful

```yaml
audit:
  project: "[name]"
  date: "YYYY-MM-DD"
  scores:
    readme: 0  # Root README with install + quickstart
    getting_started: 0  # Tutorial for first-time users
    api_reference: 0  # Every endpoint/function documented
    architecture: 0  # System design, data flow, decisions
    guides: 0  # Task-oriented how-tos
    runbooks: 0  # Operational procedures
    contributing: 0  # Dev setup, PR process, style guide
    changelog: 0  # Version history with migration notes
    troubleshooting: 0  # Common errors and solutions
    deployment: 0  # How to deploy, environments, config
  total: 0  # out of 30
  grade: "F"  # A(27-30) B(22-26) C(17-21) D(12-16) F(<12)
  priority_gaps:
    - "[highest impact missing doc]"
    - "[second priority]"
    - "[third priority]"
  estimated_effort: "[hours to reach grade B]"
```

### Priority Rules

1. README always first — it's the front door
2. Getting Started second — converts visitors to users
3. API Reference third — retains users
4. Everything else based on team pain points

## Phase 2 — Document Types & Templates

### 2.1 README Template

```markdown
# [Project Name]

[One sentence: what it does and who it's for.]

[Optional: badge row — max 4 badges: build, coverage, version, license]

## Quick Start

\`\`\`bash
# Install
[single copy-paste command]

# Run
[minimal command to see it work]
\`\`\`

Expected output:
\`\`\`
[what they should see]
\`\`\`

## What It Does

[3-5 bullet points of key capabilities...

# Technical Documentation Engine

Complete technical documentation system for AI agents — from audit through maintenance. Build docs that developers actually read.

## Install

```bash
clawhub install afrexai-technical-docs
```

## What It Does

- **Audit** existing docs with a structured scorecard (0-30 grading)
- **Generate** any doc type: READMEs, API refs, architecture docs, runbooks, ADRs, migration guides, error catalogs, changelogs, contributing guides
- **Score** documentation quality with a 100-point rubric across 8 dimensions
- **Maintain** docs with freshness tracking, debt management, and deprecation processes
- **Automate** with docs-as-code pipeline setup (lint, link check, coverage, preview)

## Quick Start

Tell your agent:

```
Audit the docs for my project
```

You'll get a scorecard showing gaps, a priority list, and effort estimates.

Then:

```
Write a README for [project]
Write a getting started guide for [feature]
Document this API endpoint: POST /users
Create a runbook for database failover
```

Every output follows battle-tested templates with examples and expected output.

## What's Inside

- 7 complete document templates (README, Getting Started, API Reference, Architecture, Runbook, Contributing, Changelog)
- 100-point quality scoring rubric
- Information architecture blueprint for developer portals
- Docs-as-code automation pipeline
- Migration guide and error catalog templates
- ADR (Architecture Decision Record) format
- Freshness tracking and documentation debt management
- Writing style guide with the 4C test

## ⚡ Level Up

Want industry-specific documentation frameworks? Our **Context Packs** ($47) include tailored documentation patterns for your vertical:

- **SaaS Pack** — API docs, SDK guides, developer portal architecture
- **Healthcare Pack** — HIPAA-compliant documentation, clinical workflow guides
- **Fintech Pack** — Regulatory documentation, audit trail templates
- **Manufacturing Pack** — SOP documentation, quality manag...