Agent skill · writing content · steipete
technical-documentation
Build and review high-quality technical docs as well as agent instruction files in your repository.
Why this skill is useful
Provides domain-specific knowledge on structuring and reviewing technical documentation workflows that the AI wouldn't reliably generate on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 385,400 stars on the source repository.
What this skill does
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 1. Classify task: build or review; context: brownfield or evergreen. 2. Inventory the requested file, directory, or diff scope early. Include governance and product docs for documentation-wide work. Repository size alone does not expand a scoped review. 3. Detect multilingual scope (README/docs in multiple languages) and define required parity level. 4. Read references/agent-and-contributing.md for agent instruction and CONTRIBUTING.md workflow rules (inventory, canonical/alias mapping, dual-mode balance, deliverable standards, and precedence/conflict handling). …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills steipete/technical-documentation