technical-documentation

Installation
SKILL.md

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 CLAUDE.md is treated as a canonical policy source and AGENTS.md should be kept as compatibility alias if present.
  • Diagnosing agent-file drift where teams had to prompt iteratively to surface missing files, broken commands, or policy conflicts.

Workflow

Related skills
Installs
121
GitHub Stars
48
First Seen
Feb 17, 2026