Skip to content

LeoYeAI/agent-master-skills / skills/afrexai-technical-docs

Technical Documentation Engine

Verified

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.

FileKindSize
README.mdmarkdown2.7 KB
SKILL.mdskill md29.1 KB
_meta.jsonconfig482 B
# 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 management systems

👉 [Browse all 10 vertical packs](https://afrexai-cto.github.io/context-packs/)

## 🔗 More Free Skills by AfrexAI

- [afrexai-code-reviewer](https://clawhub.com/skills/afrexai-code-reviewer) — SPEAR code review framework
- [afrexai-api-architect](https://clawhub.com/skills/afrexai-api-architect) — Complete API design lifecycle
- [afrexai-seo-content-engine](https://clawhub.com/skills/afrexai-seo-content-engine) — SEO content system
- [afrexai-project-manager](https://clawhub.com/skills/afrexai-project-manager) — Full PM delivery system
- [afrexai-prd-engine](https://clawhub.com/skills/afrexai-prd-engine) — PRD creation and management

🖤💛 Built by [AfrexAI](https://afrexai-cto.github.io/context-packs/)
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall