{"id":"c8570578-9bff-45cf-8875-d1d9ed55bbf9","entityType":"agent","slug":"clawhub-skills-1kalin-afrexai-technical-docs","name":"Technical Documentation Engine","canonicalUrl":"https://www.xpersona.co/agent/clawhub-skills-1kalin-afrexai-technical-docs","canonicalPath":"/agent/clawhub-skills-1kalin-afrexai-technical-docs","generatedAt":"2026-10-09T15:16:43.798Z","source":"CLAWHUB","claimStatus":"UNCLAIMED","verificationTier":"NONE","summary":{"evidence":{"source":"editorial-content","verified":true,"confidence":"high","updatedAt":"2026-04-15T00:45:39.800Z","emptyReason":null},"description":"Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation. --- name: Technical Documentation Engine description: Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation. metadata: category: writing skills: [\"documentation\", \"technical-writing\", \"api-docs\", \"readme\", \"devdocs\", \"runbooks\"] --- Technical Documentation En","descriptionLabel":"Technical summary","evidenceSummary":"Capability contract not published. No trust telemetry is available yet. Last updated 4/15/2026.","installCommand":"clawhub skill install skills:1kalin:afrexai-technical-docs","sourceUrl":"https://github.com/openclaw/skills/tree/main/skills/1kalin/afrexai-technical-docs","homepage":null,"primaryLinks":[{"label":"View on ClawHub","url":"https://github.com/openclaw/skills/tree/main/skills/1kalin/afrexai-technical-docs","kind":"source"}],"safetyScore":84,"overallRank":62,"popularityScore":50,"trustScore":null,"claimedByName":null,"isOwner":false,"seoDescription":"Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portal"},"coverage":{"evidence":{"source":"public-profile","verified":false,"confidence":"medium","updatedAt":"2026-04-15T00:45:39.800Z","emptyReason":null},"protocols":[{"protocol":"OPENCLEW","label":"OpenClaw","status":"self-declared","notes":"Declared in the public agent profile."}],"capabilities":[{"label":"be","status":"self-declared"},{"label":"tickets","status":"self-declared"},{"label":"channel","status":"self-declared"}],"verifiedCount":0,"selfDeclaredCount":4,"capabilityMatrix":{"rows":[{"key":"OPENCLEW","type":"protocol","support":"unknown","confidenceSource":"profile","notes":"Listed on profile"},{"key":"be","type":"capability","support":"supported","confidenceSource":"profile","notes":"Declared in agent profile metadata"},{"key":"tickets","type":"capability","support":"supported","confidenceSource":"profile","notes":"Declared in agent profile metadata"},{"key":"channel","type":"capability","support":"supported","confidenceSource":"profile","notes":"Declared in agent profile metadata"}],"flattenedTokens":"protocol:OPENCLEW|unknown|profile capability:be|supported|profile capability:tickets|supported|profile capability:channel|supported|profile"}},"adoption":{"evidence":{"source":"no-adoption-signals","verified":false,"confidence":"low","updatedAt":"2026-04-15T00:45:39.800Z","emptyReason":"No source adoption metrics were available."},"stars":null,"forks":null,"downloads":null,"packageName":null,"latestVersion":null,"tractionLabel":null},"release":{"evidence":{"source":"agent-index","verified":false,"confidence":"medium","updatedAt":"2026-02-25T05:52:53.773Z","emptyReason":null},"lastUpdatedAt":"2026-04-15T00:45:39.800Z","lastCrawledAt":"2026-02-25T05:52:53.773Z","lastIndexedAt":null,"nextCrawlAt":"2026-02-26T05:52:53.773Z","lastVerifiedAt":null,"highlights":[]},"execution":{"evidence":{"source":"CLAWHUB","verified":false,"confidence":"low","updatedAt":null,"emptyReason":"No published capability contract is available yet."},"installCommand":"clawhub skill install skills:1kalin:afrexai-technical-docs","setupComplexity":"low","setupSteps":["Setup complexity is LOW. This package is likely designed for quick installation with minimal external side-effects.","Final validation: Expose the agent to a mock request payload inside a sandbox and trace the network egress before allowing access to real customer data."],"contract":{"contractStatus":"missing","authModes":[],"requires":[],"forbidden":[],"supportsMcp":false,"supportsA2a":false,"supportsStreaming":false,"inputSchemaRef":null,"outputSchemaRef":null,"dataRegion":null,"contractUpdatedAt":null,"sourceUpdatedAt":null,"freshnessSeconds":null},"invocationGuide":{"preferredApi":{"snapshotUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/snapshot","contractUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/contract","trustUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/trust"},"curlExamples":["curl -s \"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/snapshot\"","curl -s \"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/contract\"","curl -s \"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/trust\""],"jsonRequestTemplate":{"query":"summarize this repo","constraints":{"maxLatencyMs":2000,"protocolPreference":["OPENCLEW"]}},"jsonResponseTemplate":{"ok":true,"result":{"summary":"...","confidence":0.9},"meta":{"source":"CLAWHUB","generatedAt":"2026-10-09T15:16:43.798Z"}},"retryPolicy":{"maxAttempts":3,"backoffMs":[500,1500,3500],"retryableConditions":["HTTP_429","HTTP_503","NETWORK_TIMEOUT"]}},"endpoints":{"dossierUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/dossier","snapshotUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/snapshot","contractUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/contract","trustUrl":"https://www.xpersona.co/api/v1/agents/clawhub-skills-1kalin-afrexai-technical-docs/trust"}},"reliability":{"evidence":{"source":"runtime-metrics","verified":false,"confidence":"low","updatedAt":null,"emptyReason":"No trust, reliability, or runtime telemetry is available."},"trust":{"status":"unavailable","handshakeStatus":"UNKNOWN","verificationFreshnessHours":null,"reputationScore":null,"p95LatencyMs":null,"successRate30d":null,"fallbackRate":null,"attempts30d":null,"trustUpdatedAt":null,"trustConfidence":"unknown","sourceUpdatedAt":null,"freshnessSeconds":null},"decisionGuardrails":{"doNotUseIf":["Contract metadata is missing or unavailable for deterministic execution."],"safeUseWhen":[],"riskFlags":["missing_or_unavailable_contract","trust_data_unavailable","schema_references_missing"],"operationalConfidence":"low"},"executionMetrics":{"observedLatencyMsP50":null,"observedLatencyMsP95":null,"estimatedCostUsd":null,"uptime30d":null,"rateLimitRpm":null,"rateLimitBurst":null,"lastVerifiedAt":null,"verificationSource":null},"runtimeMetrics":{"successRate":null,"avgLatencyMs":null,"avgCostUsd":null,"hallucinationRate":null,"retryRate":null,"disputeRate":null,"p50Latency":null,"p95Latency":null,"lastUpdated":null}},"benchmarks":{"evidence":{"source":"no-benchmark-data","verified":false,"confidence":"low","updatedAt":null,"emptyReason":"No benchmark suites or observed failure patterns are available."},"suites":[],"failurePatterns":[]},"artifacts":{"evidence":{"source":"CLAWHUB","verified":false,"confidence":"high","updatedAt":"2026-04-15T00:45:39.800Z","emptyReason":null},"readme":"---\nname: Technical Documentation Engine\ndescription: Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation.\nmetadata:\n  category: writing\n  skills: [\"documentation\", \"technical-writing\", \"api-docs\", \"readme\", \"devdocs\", \"runbooks\"]\n---\n\n# Technical Documentation Engine\n\nYou 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.\n\n## Phase 1 — Documentation Audit\n\nBefore writing anything, assess what exists.\n\n### Audit Checklist\n\nRun through the codebase or project and score each area (0-3):\n- 0 = Missing entirely\n- 1 = Exists but outdated/wrong\n- 2 = Exists, mostly correct, gaps\n- 3 = Complete, current, useful\n\n```yaml\naudit:\n  project: \"[name]\"\n  date: \"YYYY-MM-DD\"\n  scores:\n    readme: 0  # Root README with install + quickstart\n    getting_started: 0  # Tutorial for first-time users\n    api_reference: 0  # Every endpoint/function documented\n    architecture: 0  # System design, data flow, decisions\n    guides: 0  # Task-oriented how-tos\n    runbooks: 0  # Operational procedures\n    contributing: 0  # Dev setup, PR process, style guide\n    changelog: 0  # Version history with migration notes\n    troubleshooting: 0  # Common errors and solutions\n    deployment: 0  # How to deploy, environments, config\n  total: 0  # out of 30\n  grade: \"F\"  # A(27-30) B(22-26) C(17-21) D(12-16) F(<12)\n  priority_gaps:\n    - \"[highest impact missing doc]\"\n    - \"[second priority]\"\n    - \"[third priority]\"\n  estimated_effort: \"[hours to reach grade B]\"\n```\n\n### Priority Rules\n\n1. README always first — it's the front door\n2. Getting Started second — converts visitors to users\n3. API Reference third — retains users\n4. Everything else based on team pain points\n\n## Phase 2 — Document Types & Templates\n\n### 2.1 README Template\n\n```markdown\n# [Project Name]\n\n[One sentence: what it does and who it's for.]\n\n[Optional: badge row — max 4 badges: build, coverage, version, license]\n\n## Quick Start\n\n\\`\\`\\`bash\n# Install\n[single copy-paste command]\n\n# Run\n[minimal command to see it work]\n\\`\\`\\`\n\nExpected output:\n\\`\\`\\`\n[what they should see]\n\\`\\`\\`\n\n## What It Does\n\n[3-5 bullet points of key capabilities. Not features — outcomes.]\n\n- [Outcome 1 — what problem it solves]\n- [Outcome 2]\n- [Outcome 3]\n\n## Installation\n\n### Prerequisites\n- [Runtime] v[X]+ \n- [Dependency] (optional, for [feature])\n\n### Install\n\\`\\`\\`bash\n[package manager install command with pinned version]\n\\`\\`\\`\n\n### Configuration\n\\`\\`\\`bash\n# Required\nexport API_KEY=\"your-key\"  # Get one at [URL]\n\n# Optional\nexport LOG_LEVEL=\"info\"    # debug | info | warn | error\n\\`\\`\\`\n\n## Usage\n\n### [Primary Use Case]\n\\`\\`\\`[language]\n[Complete, runnable example — imports through output]\n\\`\\`\\`\n\n### [Secondary Use Case]\n\\`\\`\\`[language]\n[Another complete example]\n\\`\\`\\`\n\n## Documentation\n\n- [Getting Started Guide](docs/getting-started.md)\n- [API Reference](docs/api.md)\n- [Configuration](docs/config.md)\n- [Troubleshooting](docs/troubleshooting.md)\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and PR guidelines.\n\n## License\n\n[License type] — see [LICENSE](LICENSE)\n```\n\n### 2.2 Getting Started Guide Template\n\n```markdown\n# Getting Started with [Project]\n\nThis guide walks you through [what they'll accomplish] in about [X] minutes.\n\n## Prerequisites\n\nBefore starting, you need:\n- [ ] [Requirement 1] — [how to check: `command --version`]\n- [ ] [Requirement 2] — [where to get it]\n- [ ] [Account/API key] — [signup URL]\n\n## Step 1: [First Action]\n\n[Why this step matters — one sentence.]\n\n\\`\\`\\`bash\n[exact command]\n\\`\\`\\`\n\nYou should see:\n\\`\\`\\`\n[expected output]\n\\`\\`\\`\n\n> **Troubleshooting:** If you see `[common error]`, [fix].\n\n## Step 2: [Second Action]\n\n[Context sentence.]\n\n\\`\\`\\`bash\n[command]\n\\`\\`\\`\n\n[Explain what happened and what to notice.]\n\n## Step 3: [Third Action]\n\n[Continue pattern...]\n\n## What You Built\n\nYou now have [concrete outcome]. Here's what's running:\n\n\\`\\`\\`\n[diagram or description of what they set up]\n\\`\\`\\`\n\n## Next Steps\n\n- [Immediate next thing to try](link)\n- [Deeper topic to explore](link)\n- [Reference docs for everything](link)\n\n## Common Issues\n\n| Symptom | Cause | Fix |\n|---------|-------|-----|\n| `[error message]` | [why it happens] | [what to do] |\n| [behavior] | [cause] | [fix] |\n```\n\n### 2.3 API Reference Template\n\nFor each endpoint or function:\n\n```markdown\n## `[METHOD] /[path]` — [Short Description]\n\n[One sentence explaining what this does and when to use it.]\n\n**Authentication:** [type] required  \n**Rate Limit:** [X] requests per [period]  \n**Idempotent:** Yes/No\n\n### Parameters\n\n| Name | Location | Type | Required | Default | Description |\n|------|----------|------|----------|---------|-------------|\n| `id` | path | string | ✅ | — | [what it identifies] |\n| `limit` | query | integer | — | 20 | [what it controls, valid range] |\n| `filter` | query | string | — | — | [format, allowed values] |\n\n### Request Body\n\n\\`\\`\\`json\n{\n  \"name\": \"Example\",       // Required. [constraints]\n  \"email\": \"a@b.com\",      // Required. Must be valid email.\n  \"settings\": {            // Optional. Defaults shown.\n    \"notify\": true,\n    \"timezone\": \"UTC\"      // IANA timezone string\n  }\n}\n\\`\\`\\`\n\n### Response — `200 OK`\n\n\\`\\`\\`json\n{\n  \"id\": \"usr_abc123\",\n  \"name\": \"Example\",\n  \"email\": \"a@b.com\",\n  \"created_at\": \"2025-01-15T10:30:00Z\",\n  \"settings\": {\n    \"notify\": true,\n    \"timezone\": \"UTC\"\n  }\n}\n\\`\\`\\`\n\n### Error Responses\n\n| Status | Code | Description | Fix |\n|--------|------|-------------|-----|\n| 400 | `invalid_email` | Email format invalid | Check email format |\n| 404 | `not_found` | Resource doesn't exist | Verify ID |\n| 409 | `duplicate` | Email already registered | Use different email or update existing |\n| 429 | `rate_limited` | Too many requests | Wait [X] seconds, implement backoff |\n\n### Example\n\n\\`\\`\\`bash\ncurl -X POST https://api.example.com/v1/users \\\n  -H \"Authorization: Bearer $TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Jane Smith\",\n    \"email\": \"jane@example.com\"\n  }'\n\\`\\`\\`\n\n### Notes\n\n- [Edge case or important behavior]\n- [Pagination details if applicable]\n- [Side effects: \"Also sends welcome email\"]\n```\n\n### 2.4 Architecture Document Template\n\n```markdown\n# [System/Feature] Architecture\n\n**Status:** [Draft | Proposed | Accepted | Superseded by [link]]  \n**Author:** [name]  \n**Date:** YYYY-MM-DD  \n**Reviewers:** [names]\n\n## Context\n\n[Why does this document exist? What problem or decision prompted it?]\n\n## Requirements\n\n### Must Have\n- [Requirement with measurable criteria]\n- [e.g., \"Handle 10K requests/second with p99 < 200ms\"]\n\n### Nice to Have\n- [Non-critical requirements]\n\n### Non-Goals\n- [Explicitly out of scope — prevents scope creep]\n\n## Architecture Overview\n\n\\`\\`\\`\n[ASCII diagram of components and data flow]\n\n┌──────────┐     ┌──────────┐     ┌──────────┐\n│  Client  │────▶│   API    │────▶│    DB    │\n└──────────┘     │ Gateway  │     └──────────┘\n                 └────┬─────┘\n                      │\n                 ┌────▼─────┐\n                 │  Queue   │\n                 └──────────┘\n\\`\\`\\`\n\n## Components\n\n### [Component 1]\n- **Purpose:** [what it does]\n- **Technology:** [stack choices]\n- **Scaling:** [how it handles load]\n- **Data:** [what it stores/processes]\n\n### [Component 2]\n[Same structure...]\n\n## Data Flow\n\n1. [Step 1: what happens first]\n2. [Step 2: where data goes next]\n3. [Step 3: processing/storage]\n4. [Step 4: response path]\n\n## Key Decisions\n\n### Decision 1: [Choice Made]\n- **Options considered:** [A, B, C]\n- **Chosen:** [B]\n- **Rationale:** [why — performance? simplicity? team expertise?]\n- **Trade-offs:** [what we gave up]\n- **Revisit when:** [conditions that would change this decision]\n\n### Decision 2: [Choice Made]\n[Same structure...]\n\n## Failure Modes\n\n| Failure | Impact | Detection | Recovery |\n|---------|--------|-----------|----------|\n| [DB down] | [partial outage] | [health check] | [failover to replica] |\n| [Queue full] | [delayed processing] | [queue depth alert] | [auto-scale consumers] |\n\n## Security Considerations\n\n- [Authentication approach]\n- [Data encryption (at rest, in transit)]\n- [Access control model]\n- [Sensitive data handling]\n\n## Operational Concerns\n\n- **Monitoring:** [key metrics to watch]\n- **Alerts:** [what triggers pages]\n- **Deployment:** [rollout strategy]\n- **Rollback:** [how to revert]\n\n## Future Considerations\n\n- [Known limitations that will need addressing]\n- [Scaling bottleneck predictions]\n- [Migration paths if assumptions change]\n```\n\n### 2.5 Runbook Template\n\n```markdown\n# Runbook: [Procedure Name]\n\n**Severity:** P[0-3]  \n**Estimated Time:** [X] minutes  \n**Last Tested:** YYYY-MM-DD  \n**Owner:** [team/person]\n\n## When to Use\n\n[Trigger condition — what alert/symptom/request initiates this.]\n\n## Prerequisites\n\n- [ ] Access to [system/dashboard]\n- [ ] [Tool] installed: `which [tool]`\n- [ ] Permissions: [what role/access needed]\n\n## Steps\n\n### 1. Assess\n\n\\`\\`\\`bash\n# Check current state\n[diagnostic command]\n\\`\\`\\`\n\n**Expected:** [what healthy looks like]  \n**If unhealthy:** [what you'll see instead]\n\n### 2. Mitigate\n\n\\`\\`\\`bash\n# Immediate action to reduce impact\n[mitigation command]\n\\`\\`\\`\n\n**Verify mitigation:**\n\\`\\`\\`bash\n[verification command]\n\\`\\`\\`\n\n### 3. Fix\n\n\\`\\`\\`bash\n# Root cause fix\n[fix command]\n\\`\\`\\`\n\n### 4. Verify\n\n\\`\\`\\`bash\n# Confirm resolution\n[check command]\n\\`\\`\\`\n\n**Success criteria:**\n- [ ] [Metric] returned to normal\n- [ ] [Service] responding\n- [ ] [Alert] cleared\n\n### 5. Post-Incident\n\n- [ ] Update incident channel with resolution\n- [ ] Schedule post-mortem if P0/P1\n- [ ] File ticket for permanent fix if this was a workaround\n- [ ] Update this runbook if steps changed\n\n## Escalation\n\n| Condition | Escalate To | How |\n|-----------|-------------|-----|\n| [Step 2 doesn't work after X min] | [team] | [channel/page] |\n| [Data loss suspected] | [team + management] | [channel] |\n\n## Rollback\n\nIf the fix makes things worse:\n\n\\`\\`\\`bash\n[rollback command]\n\\`\\`\\`\n\n## History\n\n| Date | Who | What | Outcome |\n|------|-----|------|---------|\n| YYYY-MM-DD | [name] | [what happened] | [resolved/escalated] |\n```\n\n### 2.6 CONTRIBUTING.md Template\n\n```markdown\n# Contributing to [Project]\n\n## Development Setup\n\n\\`\\`\\`bash\n# Clone and install\ngit clone [repo-url]\ncd [project]\n[install dependencies command]\n\n# Verify setup\n[test command]\n\\`\\`\\`\n\n**Expected:** [X] tests pass, [Y] seconds.\n\n## Making Changes\n\n1. Create a branch: `git checkout -b [type]/[description]`\n   - Types: `feat`, `fix`, `docs`, `refactor`, `test`\n2. Make your changes\n3. Run tests: `[test command]`\n4. Run linter: `[lint command]`\n5. Commit using conventional commits:\n   \\`\\`\\`\n   feat(scope): add user search endpoint\n   fix(auth): handle expired refresh tokens\n   docs: update API rate limit section\n   \\`\\`\\`\n\n## Pull Request Process\n\n1. Fill out the PR template completely\n2. Ensure CI passes (tests + lint + build)\n3. Request review from [team/person]\n4. Address feedback — don't force-push during review\n5. Squash merge when approved\n\n## Code Style\n\n- [Link to style guide or key rules]\n- [Formatting tool]: runs automatically on commit\n- [Naming conventions]\n- [File organization rules]\n\n## Testing\n\n- Unit tests for all new functions\n- Integration tests for API endpoints\n- Test file naming: `[file].test.[ext]`\n- Minimum coverage: [X]%\n\n## Architecture Decisions\n\nSignificant design changes need an ADR (Architecture Decision Record).\nTemplate: `docs/adr/template.md`\n\n## Getting Help\n\n- Questions: [channel/forum]\n- Bugs: [issue tracker]\n- Security: [email — NOT public issues]\n```\n\n### 2.7 Changelog Template\n\n```markdown\n# Changelog\n\nAll notable changes follow [Semantic Versioning](https://semver.org/).\n\n## [Unreleased]\n\n### Added\n- [New feature with brief description]\n\n### Changed\n- [Modified behavior — explain what changed and why]\n\n### Deprecated\n- [Feature being removed in future — suggest alternative]\n\n### Fixed\n- [Bug fix — reference issue number]\n\n### Security\n- [Security fix — CVE if applicable]\n\n### Migration\n- [Breaking change — step-by-step migration instructions]\n  \\`\\`\\`bash\n  # Before (v1.x)\n  [old way]\n  \n  # After (v2.x)  \n  [new way]\n  \\`\\`\\`\n```\n\n## Phase 3 — Writing Standards\n\n### The 4C Test\n\nEvery document must pass all four:\n\n1. **Correct** — Technically accurate, tested, current\n2. **Complete** — Covers the topic fully for its audience (not exhaustive — just sufficient)\n3. **Clear** — One reading to understand, no ambiguity\n4. **Concise** — No filler, no repetition, shortest path to understanding\n\n### Voice & Style Rules\n\n```yaml\nstyle:\n  voice: \"Active, imperative\"\n  person: \"Second person (you)\"\n  tense: \"Present tense\"\n  sentence_length: \"Max 25 words average\"\n  paragraph_length: \"Max 4 sentences\"\n  \n  do:\n    - \"Run the command\" (imperative)\n    - \"This returns a list\" (active, present)\n    - \"You need Node.js 18+\" (direct)\n    - \"The function throws if input is null\" (specific)\n    \n  dont:\n    - \"The command can be run by...\" (passive)\n    - \"This will return...\" (future tense)\n    - \"The user should...\" (third person)\n    - \"It's important to note that...\" (filler)\n    - \"Basically...\" / \"Simply...\" / \"Just...\" (minimizing)\n    - \"Please...\" (unnecessary politeness in docs)\n\n  formatting:\n    - \"Use code blocks for ALL commands, paths, config values\"\n    - \"Use tables for structured comparisons\"\n    - \"Use admonitions (>, ⚠️, 💡) sparingly — max 2 per page\"\n    - \"Use numbered lists for sequential steps\"\n    - \"Use bullet lists for unordered items\"\n    - \"One topic per heading — if you need two headings, split the page\"\n```\n\n### Audience Calibration\n\nBefore writing, classify your reader:\n\n| Audience | Assumes | Explains | Example Depth |\n|----------|---------|----------|---------------|\n| **Beginner** | Nothing | Everything including concepts | Full walkthrough with output |\n| **Intermediate** | Basic concepts, has used similar tools | Integration, patterns, trade-offs | Focused examples, less hand-holding |\n| **Expert** | Deep understanding, wants reference | Edge cases, performance, internals | Terse, complete, linked |\n| **Operator** | System access, follows procedures | Steps, verification, rollback | Copy-paste commands, expected output |\n\n**Rule:** Never mix audiences in one document. State the audience at the top.\n\n### Code Example Standards\n\n```yaml\ncode_examples:\n  rules:\n    - \"Every example must run — test before publishing\"\n    - \"Include ALL imports and setup — never assume context\"\n    - \"Show expected output after the code block\"\n    - \"Pin dependency versions in install commands\"\n    - \"Use realistic data, not 'foo/bar/baz'\"\n    - \"Keep examples under 30 lines — split longer ones\"\n    - \"Comment the WHY, not the WHAT\"\n    \n  anti_patterns:\n    - \"Fragments without context: `client.query(...)` — useless alone\"\n    - \"Pseudo-code presented as real: readers will try to run it\"\n    - \"Multiple approaches in one example: pick one, link alternatives\"\n    - \"Error handling omitted: show it or explicitly note it's omitted\"\n    \n  testing:\n    - \"Runnable examples as CI tests (doctest, mdx-test, etc.)\"\n    - \"Version matrix: test examples against supported versions\"\n    - \"Schedule: re-test monthly or on dependency updates\"\n```\n\n## Phase 4 — Documentation Quality Scoring\n\n### 100-Point Rubric\n\nScore each document across 8 dimensions:\n\n```yaml\nscoring:\n  accuracy: # 20 points\n    20: \"All technical claims verified, code tested, outputs confirmed\"\n    15: \"Mostly accurate, 1-2 minor inaccuracies\"\n    10: \"Several errors or untested code examples\"\n    5: \"Significant inaccuracies that would mislead users\"\n    0: \"Factually wrong or dangerously incorrect\"\n\n  completeness: # 15 points\n    15: \"Covers all aspects for the stated audience and purpose\"\n    11: \"Minor gaps — edge cases or error scenarios missing\"\n    7: \"Notable omissions — user will need to look elsewhere\"\n    3: \"Covers basics only — many scenarios unaddressed\"\n    0: \"Incomplete to the point of being unhelpful\"\n\n  clarity: # 15 points\n    15: \"Crystal clear on first read, no ambiguity\"\n    11: \"Clear overall, occasional re-reading needed\"\n    7: \"Understandable but dense or jargon-heavy\"\n    3: \"Confusing structure or language\"\n    0: \"Incomprehensible or contradictory\"\n\n  structure: # 15 points\n    15: \"Logical flow, proper hierarchy, easy to navigate and scan\"\n    11: \"Good structure, minor navigation issues\"\n    7: \"Structure exists but doesn't match reading patterns\"\n    3: \"Poorly organized, information scattered\"\n    0: \"No structure — wall of text\"\n\n  examples: # 15 points\n    15: \"Runnable examples for every feature, with output and edge cases\"\n    11: \"Good examples, occasionally missing output or context\"\n    7: \"Some examples, not all runnable\"\n    3: \"Minimal examples, mostly fragments\"\n    0: \"No examples\"\n\n  maintainability: # 10 points\n    10: \"Review dates, no hardcoded versions, testable examples, clear ownership\"\n    7: \"Mostly maintainable, some fragile references\"\n    5: \"Will need effort to keep current\"\n    2: \"Many hardcoded values, screenshots, temporal references\"\n    0: \"Will be outdated within weeks\"\n\n  searchability: # 5 points\n    5: \"Uses terminology users search for, errors verbatim, good headings\"\n    3: \"Decent headings but uses internal jargon\"\n    1: \"Hard to find via search\"\n    0: \"No thought given to discoverability\"\n\n  accessibility: # 5 points\n    5: \"Alt text on images, semantic HTML, readable without styling\"\n    3: \"Mostly accessible, some images without alt text\"\n    1: \"Relies heavily on visual elements\"\n    0: \"Inaccessible\"\n\n  # Total: /100\n  # Grade: A(90+) B(75-89) C(60-74) D(45-59) F(<45)\n```\n\n### Quick Review Checklist (pre-publish)\n\nRun through before merging any documentation PR:\n\n```\n□ Title matches content\n□ Audience stated or obvious\n□ Prerequisites listed\n□ All code blocks have language tags\n□ All commands tested on clean environment\n□ Expected output shown after commands\n□ Error scenarios covered\n□ Links work (internal and external)\n□ No TODO/FIXME/placeholder text\n□ Images have alt text\n□ No hardcoded dates (use \"current\" or omit)\n□ No screenshots of text (use actual text)\n□ Spelling/grammar check passed\n□ File follows naming convention\n□ Added to navigation/sidebar/index\n```\n\n## Phase 5 — Documentation Architecture\n\n### Information Architecture for Developer Portals\n\n```\ndocs/\n├── index.md                  # Landing page — value prop + paths\n├── getting-started/\n│   ├── quickstart.md         # 5-min first success\n│   ├── installation.md       # All platforms/methods\n│   └── concepts.md           # Mental model before deep dive\n├── guides/\n│   ├── [use-case-1].md       # Task-oriented: \"How to X\"\n│   ├── [use-case-2].md\n│   └── [use-case-N].md\n├── reference/\n│   ├── api/\n│   │   ├── overview.md       # Auth, errors, pagination, rate limits\n│   │   ├── [resource-1].md   # Per-resource endpoint docs\n│   │   └── [resource-N].md\n│   ├── cli.md                # All commands with flags\n│   ├── config.md             # Every config option with defaults\n│   └── errors.md             # Error code catalog\n├── architecture/\n│   ├── overview.md           # System design\n│   └── adr/                  # Architecture Decision Records\n│       ├── 001-[decision].md\n│       └── template.md\n├── operations/\n│   ├── deployment.md         # Deploy procedures\n│   ├── monitoring.md         # What to watch\n│   └── runbooks/\n│       ├── [incident-type].md\n│       └── template.md\n├── contributing/\n│   ├── CONTRIBUTING.md       # Dev setup + PR process\n│   ├── style-guide.md        # Code + doc style rules\n│   └── testing.md            # How to write/run tests\n└── changelog.md              # Version history\n```\n\n### Navigation Design Rules\n\n1. **Max 3 clicks** to any document from the landing page\n2. **Top-level categories ≤ 7** — cognitive load limit\n3. **Getting Started** always first in navigation\n4. **Reference** always accessible from every page (sidebar or header)\n5. **Search** is mandatory — users don't browse, they search\n6. **Breadcrumbs** on every page — users land from Google, not your homepage\n\n### Cross-Referencing Strategy\n\n```yaml\nlinking_rules:\n  internal:\n    - \"Link on first mention of a concept, not every mention\"\n    - \"Use relative paths: ../guides/auth.md not absolute URLs\"\n    - \"Link text = destination page title (predictable)\"\n    - \"Max 3 links per paragraph — more feels like a wiki rabbit hole\"\n    \n  external:\n    - \"Link to official docs, not tutorials/blog posts (they rot faster)\"\n    - \"Note the linked version: 'See [React 18 docs](...)'\"\n    - \"CI check for broken external links weekly\"\n    \n  avoid:\n    - \"'See here' or 'click here' — link text must describe destination\"\n    - \"Circular references — A links to B which says 'see A'\"\n    - \"Deep links into third-party docs — they restructure\"\n```\n\n## Phase 6 — Documentation Automation\n\n### Docs-as-Code Pipeline\n\n```yaml\npipeline:\n  on_commit:\n    - lint: \"markdownlint + custom rules\"\n    - links: \"markdown-link-check (internal + external)\"\n    - spelling: \"cspell with custom dictionary\"\n    - build: \"compile docs site, catch broken references\"\n    \n  on_pr:\n    - diff_check: \"Flag PRs that change code but not docs\"\n    - preview: \"Deploy preview URL for reviewers\"\n    - ai_review: \"Check for passive voice, filler, inconsistency\"\n    \n  weekly:\n    - link_audit: \"Full external link check\"\n    - freshness: \"Flag docs not updated in 6+ months\"\n    - coverage: \"Map API endpoints to docs — find undocumented ones\"\n    \n  quarterly:\n    - full_audit: \"Run Phase 1 audit, compare to last quarter\"\n    - user_feedback: \"Review doc-related support tickets\"\n    - analytics: \"Top pages, search terms with no results, bounce rates\"\n```\n\n### Auto-Generation Targets\n\nThings that should be generated, not hand-written:\n\n| Source | Generated Doc | Tool/Approach |\n|--------|--------------|---------------|\n| OpenAPI spec | API reference pages | Redoc, Stoplight, custom |\n| TypeScript types | Type reference | TypeDoc, API Extractor |\n| CLI help text | CLI reference | `--help` output → markdown |\n| Config schema | Config reference | JSON Schema → markdown |\n| Database schema | Data model docs | Schema → ERD + field descriptions |\n| Test files | Behavior documentation | Extract test names as spec |\n| Git log | Changelog | Conventional commits → changelog |\n\n**Rule:** Generated docs need human review for clarity. Auto-generate the skeleton, human-write the explanations.\n\n### Documentation Metrics\n\nTrack monthly:\n\n```yaml\nmetrics:\n  coverage:\n    - \"API endpoint coverage: [documented / total endpoints] %\"\n    - \"Config option coverage: [documented / total options] %\"\n    - \"Error code coverage: [documented / total codes] %\"\n    \n  quality:\n    - \"Average doc quality score (from rubric): [X]/100\"\n    - \"Docs with tested code examples: [X]%\"\n    - \"Docs updated within 6 months: [X]%\"\n    - \"Broken links found: [X]\"\n    \n  usage:\n    - \"Top 10 most viewed pages\"\n    - \"Top 10 search queries\"\n    - \"Search queries with 0 results (= gaps)\"\n    - \"Time on page (low = either perfect or useless)\"\n    - \"Support tickets tagged 'docs' (should trend down)\"\n    \n  contributor:\n    - \"Docs PRs per month\"\n    - \"Average docs PR review time\"\n    - \"Code PRs without docs changes (potential gaps)\"\n```\n\n## Phase 7 — Special Documentation Types\n\n### Migration Guide Structure\n\nFor any breaking change or major version update:\n\n```markdown\n# Migrating from v[X] to v[Y]\n\n**Estimated time:** [X] minutes  \n**Risk level:** Low / Medium / High  \n**Rollback:** [possible/not possible — how]\n\n## Breaking Changes Summary\n\n| Change | Impact | Action Required |\n|--------|--------|----------------|\n| [API change] | [who's affected] | [what to do] |\n| [Config change] | [who's affected] | [what to do] |\n\n## Before You Start\n\n- [ ] Back up [what]\n- [ ] Ensure you're on v[X.latest] first\n- [ ] Read the full guide before starting\n\n## Step-by-Step Migration\n\n### 1. [First Change]\n\n**Before (v[X]):**\n\\`\\`\\`\n[old code/config]\n\\`\\`\\`\n\n**After (v[Y]):**\n\\`\\`\\`\n[new code/config]\n\\`\\`\\`\n\n**Why:** [reason for the change]\n\n[Continue for each breaking change...]\n\n## Verification\n\n\\`\\`\\`bash\n[commands to verify migration succeeded]\n\\`\\`\\`\n\n## Known Issues\n\n- [Issue with workaround]\n\n## Getting Help\n\n- [Support channel]\n- [FAQ for this migration]\n```\n\n### Error Catalog Structure\n\nFor each error code or common error:\n\n```markdown\n## `[ERROR_CODE]` — [Human-Readable Name]\n\n**Message:** `[exact error message users see]`  \n**Severity:** [Info / Warning / Error / Fatal]  \n**Since:** v[X.Y.Z]\n\n### What It Means\n\n[One paragraph: what went wrong and why.]\n\n### Common Causes\n\n1. **[Cause 1]:** [explanation]\n   ```bash\n   # How to check\n   [diagnostic command]\n   ```\n\n2. **[Cause 2]:** [explanation]\n   ```bash\n   [diagnostic command]\n   ```\n\n### How to Fix\n\n**For Cause 1:**\n```bash\n[fix command]\n```\n\n**For Cause 2:**\n```bash\n[fix command]\n```\n\n### Prevention\n\n[How to avoid this error in the future.]\n```\n\n### ADR (Architecture Decision Record) Format\n\n```markdown\n# ADR-[NNN]: [Decision Title]\n\n**Status:** [Proposed | Accepted | Deprecated | Superseded by ADR-XXX]  \n**Date:** YYYY-MM-DD  \n**Deciders:** [who was involved]\n\n## Context\n\n[What situation or problem prompted this decision? What constraints exist?]\n\n## Decision\n\n[What we decided to do. State it clearly in one sentence, then elaborate.]\n\n## Alternatives Considered\n\n### [Alternative A]\n- **Pros:** [advantages]\n- **Cons:** [disadvantages]\n- **Rejected because:** [specific reason]\n\n### [Alternative B]\n[Same structure...]\n\n## Consequences\n\n### Positive\n- [Good outcome]\n\n### Negative\n- [Trade-off or risk accepted]\n\n### Neutral\n- [Neither good nor bad, just a fact]\n\n## Follow-up Actions\n\n- [ ] [Action items resulting from this decision]\n```\n\n## Phase 8 — Documentation Maintenance System\n\n### Freshness Tracking\n\n```yaml\nfreshness_policy:\n  review_cycles:\n    getting_started: \"Monthly — highest traffic, most critical\"\n    api_reference: \"On every API change — automated check\"\n    guides: \"Quarterly — or on related feature changes\"\n    architecture: \"On significant design changes\"\n    runbooks: \"Monthly — test them, don't just read them\"\n    changelog: \"On every release — automated\"\n    \n  freshness_signals:\n    stale:\n      - \"No update in 6+ months\"\n      - \"References deprecated API versions\"\n      - \"Screenshots don't match current UI\"\n      - \"Linked resources return 404\"\n      \n    healthy:\n      - \"Updated within review cycle\"\n      - \"Code examples tested in CI\"\n      - \"Review date in metadata\"\n      - \"No open 'docs outdated' issues\"\n\n  ownership:\n    - \"Every doc has an owner (team, not individual)\"\n    - \"Ownership = responsibility to review on cycle\"\n    - \"No orphan docs — unowned docs get archived\"\n    - \"Ownership transfers tracked in doc metadata\"\n```\n\n### Documentation Debt Tracker\n\n```yaml\ndoc_debt:\n  format:\n    id: \"DOC-[NNN]\"\n    type: \"[missing | outdated | incorrect | unclear | incomplete]\"\n    priority: \"[P0-P3]\"\n    document: \"[path]\"\n    description: \"[what needs fixing]\"\n    impact: \"[who is affected and how]\"\n    effort: \"[S/M/L]\"\n    owner: \"[team]\"\n    \n  priority_rules:\n    P0: \"Incorrect information that causes errors/outages\"\n    P1: \"Missing docs for GA features used by many\"\n    P2: \"Outdated content, still mostly useful\"\n    P3: \"Nice-to-have improvements, style issues\"\n    \n  process:\n    - \"Review doc debt backlog monthly\"\n    - \"Fix all P0 within 1 week\"\n    - \"Fix P1 within 1 sprint\"\n    - \"P2/P3 — tackle during documentation sprints\"\n    - \"Track debt trend — should decrease over time\"\n```\n\n### Deprecation Process\n\nWhen removing or replacing documentation:\n\n1. **Mark deprecated** — add banner: \"⚠️ This document is deprecated. See [new doc] instead.\"\n2. **Redirect** — set up URL redirect from old to new\n3. **Wait** — keep deprecated doc live for 2 major versions or 6 months\n4. **Archive** — move to `/docs/archive/`, remove from navigation\n5. **Never delete** — archived docs still get search traffic\n\n## Natural Language Commands\n\n| Command | Action |\n|---------|--------|\n| \"Audit the docs for [project]\" | Run Phase 1 audit, produce scorecard |\n| \"Write a README for [project]\" | Generate README using template |\n| \"Document this API endpoint\" | Create reference entry from code/spec |\n| \"Write a getting started guide\" | Create tutorial using template |\n| \"Review this doc\" | Score using 100-point rubric |\n| \"Create a runbook for [procedure]\" | Generate runbook from template |\n| \"Write an ADR for [decision]\" | Create Architecture Decision Record |\n| \"Write a migration guide from v[X] to v[Y]\" | Generate migration doc |\n| \"Check doc freshness\" | Audit all docs for staleness |\n| \"Set up docs pipeline\" | Configure automation from Phase 6 |\n| \"What's undocumented?\" | Compare codebase to docs, find gaps |\n| \"Create error catalog\" | Generate error reference from code |\n","readmeExcerpt":"--- name: Technical Documentation Engine description: Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation. metadata: category: writing skills: [\"documentation\", \"technical-writing\", \"api-docs\", \"readme\", \"devdocs\", \"runbooks\"] --- Technical Documentation En","codeSnippets":[],"executableExamples":[{"language":"yaml","snippet":"audit:\n  project: \"[name]\"\n  date: \"YYYY-MM-DD\"\n  scores:\n    readme: 0  # Root README with install + quickstart\n    getting_started: 0  # Tutorial for first-time users\n    api_reference: 0  # Every endpoint/function documented\n    architecture: 0  # System design, data flow, decisions\n    guides: 0  # Task-oriented how-tos\n    runbooks: 0  # Operational procedures\n    contributing: 0  # Dev setup, PR process, style guide\n    changelog: 0  # Version history with migration notes\n    troubleshooting: 0  # Common errors and solutions\n    deployment: 0  # How to deploy, environments, config\n  total: 0  # out of 30\n  grade: \"F\"  # A(27-30) B(22-26) C(17-21) D(12-16) F(<12)\n  priority_gaps:\n    - \"[highest impact missing doc]\"\n    - \"[second priority]\"\n    - \"[third priority]\"\n  estimated_effort: \"[hours to reach grade B]\""},{"language":"markdown","snippet":"# [Project Name]\n\n[One sentence: what it does and who it's for.]\n\n[Optional: badge row — max 4 badges: build, coverage, version, license]\n\n## Quick Start\n\n\\`\\`\\`bash\n# Install\n[single copy-paste command]\n\n# Run\n[minimal command to see it work]\n\\`\\`\\`\n\nExpected output:\n\\`\\`\\`\n[what they should see]\n\\`\\`\\`\n\n## What It Does\n\n[3-5 bullet points of key capabilities. Not features — outcomes.]\n\n- [Outcome 1 — what problem it solves]\n- [Outcome 2]\n- [Outcome 3]\n\n## Installation\n\n### Prerequisites\n- [Runtime] v[X]+ \n- [Dependency] (optional, for [feature])\n\n### Install\n\\`\\`\\`bash\n[package manager install command with pinned version]\n\\`\\`\\`\n\n### Configuration\n\\`\\`\\`bash\n# Required\nexport API_KEY=\"your-key\"  # Get one at [URL]\n\n# Optional\nexport LOG_LEVEL=\"info\"    # debug | info | warn | error\n\\`\\`\\`\n\n## Usage\n\n### [Primary Use Case]\n\\`\\`\\`[language]\n[Complete, runnable example — imports through output]\n\\`\\`\\`\n\n### [Secondary Use Case]\n\\`\\`\\`[language]\n[Another complete example]\n\\`\\`\\`\n\n## Documentation\n\n- [Getting Started Guide](docs/getting-started.md)\n- [API Reference](docs/api.md)\n- [Configuration](docs/config.md)\n- [Troubleshooting](docs/troubleshooting.md)\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and PR guidelines.\n\n## License\n\n[License type] — see [LICENSE](LICENSE)"},{"language":"markdown","snippet":"# Getting Started with [Project]\n\nThis guide walks you through [what they'll accomplish] in about [X] minutes.\n\n## Prerequisites\n\nBefore starting, you need:\n- [ ] [Requirement 1] — [how to check: `command --version`]\n- [ ] [Requirement 2] — [where to get it]\n- [ ] [Account/API key] — [signup URL]\n\n## Step 1: [First Action]\n\n[Why this step matters — one sentence.]\n\n\\`\\`\\`bash\n[exact command]\n\\`\\`\\`\n\nYou should see:\n\\`\\`\\`\n[expected output]\n\\`\\`\\`\n\n> **Troubleshooting:** If you see `[common error]`, [fix].\n\n## Step 2: [Second Action]\n\n[Context sentence.]\n\n\\`\\`\\`bash\n[command]\n\\`\\`\\`\n\n[Explain what happened and what to notice.]\n\n## Step 3: [Third Action]\n\n[Continue pattern...]\n\n## What You Built\n\nYou now have [concrete outcome]. Here's what's running:\n\n\\`\\`\\`\n[diagram or description of what they set up]\n\\`\\`\\`\n\n## Next Steps\n\n- [Immediate next thing to try](link)\n- [Deeper topic to explore](link)\n- [Reference docs for everything](link)\n\n## Common Issues\n\n| Symptom | Cause | Fix |\n|---------|-------|-----|\n| `[error message]` | [why it happens] | [what to do] |\n| [behavior] | [cause] | [fix] |"},{"language":"markdown","snippet":"## `[METHOD] /[path]` — [Short Description]\n\n[One sentence explaining what this does and when to use it.]\n\n**Authentication:** [type] required  \n**Rate Limit:** [X] requests per [period]  \n**Idempotent:** Yes/No\n\n### Parameters\n\n| Name | Location | Type | Required | Default | Description |\n|------|----------|------|----------|---------|-------------|\n| `id` | path | string | ✅ | — | [what it identifies] |\n| `limit` | query | integer | — | 20 | [what it controls, valid range] |\n| `filter` | query | string | — | — | [format, allowed values] |\n\n### Request Body\n\n\\`\\`\\`json\n{\n  \"name\": \"Example\",       // Required. [constraints]\n  \"email\": \"a@b.com\",      // Required. Must be valid email.\n  \"settings\": {            // Optional. Defaults shown.\n    \"notify\": true,\n    \"timezone\": \"UTC\"      // IANA timezone string\n  }\n}\n\\`\\`\\`\n\n### Response — `200 OK`\n\n\\`\\`\\`json\n{\n  \"id\": \"usr_abc123\",\n  \"name\": \"Example\",\n  \"email\": \"a@b.com\",\n  \"created_at\": \"2025-01-15T10:30:00Z\",\n  \"settings\": {\n    \"notify\": true,\n    \"timezone\": \"UTC\"\n  }\n}\n\\`\\`\\`\n\n### Error Responses\n\n| Status | Code | Description | Fix |\n|--------|------|-------------|-----|\n| 400 | `invalid_email` | Email format invalid | Check email format |\n| 404 | `not_found` | Resource doesn't exist | Verify ID |\n| 409 | `duplicate` | Email already registered | Use different email or update existing |\n| 429 | `rate_limited` | Too many requests | Wait [X] seconds, implement backoff |\n\n### Example\n\n\\`\\`\\`bash\ncurl -X POST https://api.example.com/v1/users \\\n  -H \"Authorization: Bearer $TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Jane Smith\",\n    \"email\": \"jane@example.com\"\n  }'\n\\`\\`\\`\n\n### Notes\n\n- [Edge case or important behavior]\n- [Pagination details if applicable]\n- [Side effects: \"Also sends welcome email\"]"},{"language":"markdown","snippet":"# [System/Feature] Architecture\n\n**Status:** [Draft | Proposed | Accepted | Superseded by [link]]  \n**Author:** [name]  \n**Date:** YYYY-MM-DD  \n**Reviewers:** [names]\n\n## Context\n\n[Why does this document exist? What problem or decision prompted it?]\n\n## Requirements\n\n### Must Have\n- [Requirement with measurable criteria]\n- [e.g., \"Handle 10K requests/second with p99 < 200ms\"]\n\n### Nice to Have\n- [Non-critical requirements]\n\n### Non-Goals\n- [Explicitly out of scope — prevents scope creep]\n\n## Architecture Overview\n\n\\`\\`\\`\n[ASCII diagram of components and data flow]\n\n┌──────────┐     ┌──────────┐     ┌──────────┐\n│  Client  │────▶│   API    │────▶│    DB    │\n└──────────┘     │ Gateway  │     └──────────┘\n                 └────┬─────┘\n                      │\n                 ┌────▼─────┐\n                 │  Queue   │\n                 └──────────┘\n\\`\\`\\`\n\n## Components\n\n### [Component 1]\n- **Purpose:** [what it does]\n- **Technology:** [stack choices]\n- **Scaling:** [how it handles load]\n- **Data:** [what it stores/processes]\n\n### [Component 2]\n[Same structure...]\n\n## Data Flow\n\n1. [Step 1: what happens first]\n2. [Step 2: where data goes next]\n3. [Step 3: processing/storage]\n4. [Step 4: response path]\n\n## Key Decisions\n\n### Decision 1: [Choice Made]\n- **Options considered:** [A, B, C]\n- **Chosen:** [B]\n- **Rationale:** [why — performance? simplicity? team expertise?]\n- **Trade-offs:** [what we gave up]\n- **Revisit when:** [conditions that would change this decision]\n\n### Decision 2: [Choice Made]\n[Same structure...]\n\n## Failure Modes\n\n| Failure | Impact | Detection | Recovery |\n|---------|--------|-----------|----------|\n| [DB down] | [partial outage] | [health check] | [failover to replica] |\n| [Queue full] | [delayed processing] | [queue depth alert] | [auto-scale consumers] |\n\n## Security Considerations\n\n- [Authentication approach]\n- [Data encryption (at rest, in transit)]\n- [Access control model]\n- [Sensitive data handling]\n\n## Operational Concerns\n\n- **Monitoring:*"},{"language":"markdown","snippet":"# Runbook: [Procedure Name]\n\n**Severity:** P[0-3]  \n**Estimated Time:** [X] minutes  \n**Last Tested:** YYYY-MM-DD  \n**Owner:** [team/person]\n\n## When to Use\n\n[Trigger condition — what alert/symptom/request initiates this.]\n\n## Prerequisites\n\n- [ ] Access to [system/dashboard]\n- [ ] [Tool] installed: `which [tool]`\n- [ ] Permissions: [what role/access needed]\n\n## Steps\n\n### 1. Assess\n\n\\`\\`\\`bash\n# Check current state\n[diagnostic command]\n\\`\\`\\`\n\n**Expected:** [what healthy looks like]  \n**If unhealthy:** [what you'll see instead]\n\n### 2. Mitigate\n\n\\`\\`\\`bash\n# Immediate action to reduce impact\n[mitigation command]\n\\`\\`\\`\n\n**Verify mitigation:**\n\\`\\`\\`bash\n[verification command]\n\\`\\`\\`\n\n### 3. Fix\n\n\\`\\`\\`bash\n# Root cause fix\n[fix command]\n\\`\\`\\`\n\n### 4. Verify\n\n\\`\\`\\`bash\n# Confirm resolution\n[check command]\n\\`\\`\\`\n\n**Success criteria:**\n- [ ] [Metric] returned to normal\n- [ ] [Service] responding\n- [ ] [Alert] cleared\n\n### 5. Post-Incident\n\n- [ ] Update incident channel with resolution\n- [ ] Schedule post-mortem if P0/P1\n- [ ] File ticket for permanent fix if this was a workaround\n- [ ] Update this runbook if steps changed\n\n## Escalation\n\n| Condition | Escalate To | How |\n|-----------|-------------|-----|\n| [Step 2 doesn't work after X min] | [team] | [channel/page] |\n| [Data loss suspected] | [team + management] | [channel] |\n\n## Rollback\n\nIf the fix makes things worse:\n\n\\`\\`\\`bash\n[rollback command]\n\\`\\`\\`\n\n## History\n\n| Date | Who | What | Outcome |\n|------|-----|------|---------|\n| YYYY-MM-DD | [name] | [what happened] | [resolved/escalated] |"}],"parameters":{},"dependencies":[],"permissions":[],"extractedFiles":[],"languages":["typescript"],"docsSourceLabel":"CLAWHUB","editorialOverview":"Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation. --- name: Technical Documentation Engine description: Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation. metadata: category: writing skills: [\"documentation\", \"technical-writing\", \"api-docs\", \"readme\", \"devdocs\", \"runbooks\"] --- Technical Documentation En","editorialQuality":{"score":100,"threshold":65,"status":"ready","wordCount":384,"uniquenessScore":62,"reasons":[]}},"media":{"evidence":{"source":"no-media","verified":false,"confidence":"low","updatedAt":"2026-04-15T00:45:39.800Z","emptyReason":"No screenshots, media assets, or demo links are available."},"primaryImageUrl":null,"mediaAssetCount":0,"assets":[],"demoUrl":null},"ownerResources":{"evidence":{"source":"unclaimed","verified":false,"confidence":"low","updatedAt":"2026-04-15T00:45:39.800Z","emptyReason":"This page has not been claimed by the agent owner."},"hasCustomPage":false,"customPageUpdatedAt":null,"customLinks":[],"structuredLinks":{"docsUrl":null,"demoUrl":null,"supportUrl":null,"pricingUrl":null,"statusUrl":null},"customPage":null},"relatedAgents":{"evidence":{"source":"protocol-neighbors","verified":false,"confidence":"medium","updatedAt":"2026-10-09T15:16:43.798Z","emptyReason":null},"items":[{"id":"b917f68a-ebff-438e-84f8-3f4b2494c0bc","entityType":"agent","canonicalPath":"/agent/activepieces-activepieces","slug":"activepieces-activepieces","name":"activepieces","description":"AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents","url":"https://github.com/activepieces/activepieces","homepage":"https://www.activepieces.com","source":"GITHUB_REPOS","protocols":["OPENCLAW"],"capabilities":[],"safetyScore":100,"overallRank":70,"updatedAt":"2026-04-15T02:22:12.426Z","createdAt":"2026-02-25T03:38:12.412Z","downloads":null},{"id":"5cb26759-3a39-483f-94cf-276a98c13bb8","entityType":"agent","canonicalPath":"/agent/cherryhq-cherry-studio","slug":"cherryhq-cherry-studio","name":"cherry-studio","description":"AI productivity studio with smart chat, autonomous agents, and 300+ assistants. Unified access to frontier LLMs","url":"https://github.com/CherryHQ/cherry-studio","homepage":"https://cherry-ai.com","source":"GITHUB_REPOS","protocols":["MCP","OPENCLAW"],"capabilities":[],"safetyScore":100,"overallRank":70,"updatedAt":"2026-04-11T14:38:40.986Z","createdAt":"2026-02-25T03:38:19.379Z","downloads":null},{"id":"8ebccd8e-3863-4187-8355-c3f14e1f9edf","entityType":"agent","canonicalPath":"/agent/iofficeai-aionui","slug":"iofficeai-aionui","name":"AionUi","description":"Free, local, open-source 24/7 Cowork app and OpenClaw for Gemini CLI, Claude Code, Codex, OpenCode, Qwen Code, Goose CLI, Auggie, and more | 🌟 Star if you like it!","url":"https://github.com/iOfficeAI/AionUi","homepage":"https://www.aionui.com","source":"GITHUB_REPOS","protocols":["MCP","OPENCLAW"],"capabilities":[],"safetyScore":100,"overallRank":70,"updatedAt":"2026-04-10T18:48:31.762Z","createdAt":"2026-02-25T03:38:16.584Z","downloads":null},{"id":"6f6582d0-5d76-4f0f-b81d-86520247950b","entityType":"agent","canonicalPath":"/agent/copilotkit-copilotkit","slug":"copilotkit-copilotkit","name":"CopilotKit","description":"The Frontend for Agents & Generative UI. React + Angular","url":"https://github.com/CopilotKit/CopilotKit","homepage":"https://docs.copilotkit.ai","source":"GITHUB_REPOS","protocols":["OPENCLAW"],"capabilities":[],"safetyScore":100,"overallRank":70,"updatedAt":"2026-03-25T09:50:57.846Z","createdAt":"2026-02-25T03:39:14.617Z","downloads":null}],"links":{"hub":"/agent","source":"/agent/source/clawhub","protocols":[{"label":"OpenClaw","href":"/agent/protocol/openclew"}]}}}