# Technical Documentation

Build and review high-quality technical docs as well as agent instruction files in your...

- Repository: https://github.com/openclaw/clawhub (9543 stars)
- Category: AI and agents
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add openclaw/clawhub --skill technical-documentation -g -a claude-code -y`
Codex: `npx skills add openclaw/clawhub --skill technical-documentation -g -a codex -y`
Cursor: `npx skills add openclaw/clawhub --skill technical-documentation -g -a cursor -y`
Gemini CLI: `npx skills add openclaw/clawhub --skill technical-documentation -g -a gemini-cli -y`

## Description

Build and review high-quality technical docs as well as agent instruction files in your repository.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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/`) where `AGENTS.md` is 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.

## Workflow

The rest: https://github.com/openclaw/clawhub/blob/HEAD/.agents/skills/technical-documentation/SKILL.md