Technical Documentation
Build and review high-quality technical docs as well as agent instruction files in your...
Install
npx skills add openclaw/clawhub --skill technical-documentation -g -a claude-code -y- Repository
- openclaw/clawhub9.5k
- Category
- AI and agents
- Updated
- 3d ago
- License
- MIT
- Context cost
- Lightabout 1,400 tokens
- Runs scripts
- No, instructions only
What it does
Build and review high-quality technical docs as well as agent instruction files in your repository.
Technical Documentation
Purpose
Produce and review technical documentation that is clear, actionable, and maintainable for both humans and agents, including contributor-governance files and agent instruction files.
When to use
- Creating or overhauling docs in an existing product/codebase (brownfield).
- Building evergreen docs meant to stay accurate and reusable over time.
- Reviewing doc diffs for structure, clarity, and operational correctness.
- Running full-repo documentation audits that must include both governance files and product docs surfaces (
docs/,README*,.md/.mdx/.mdc, Fern/Sphinx/Mintlify-style sources). - Updating or reviewing AGENTS.md and/or CONTRIBUTING.md to keep agent and contributor workflows aligned with current repo practices.
- Improving repository onboarding/docs that include contribution instructions, issue templates, PR flow, and review gates.
- Designing governance documentation strategy for repos with alias instruction files (for example
CLAUDE.md,AGENT.md,.cursorrules,.cursor/rules/*,.agent/,.agents/,.pi/) whereAGENTS.mdis treated as canonical when present and aliases should be kept as compatibility surfaces. - Diagnosing agent-file drift where teams had to prompt iteratively to surface missing files, broken commands, or policy conflicts.
- Applying repository-specific documentation overlays, including OpenClaw page-type, docs IA, preservation, and validation rules when present.
