technical-documentation
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/) whereCLAUDE.mdis treated as a canonical policy source andAGENTS.mdshould 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
More from vincentkoc/dotskills
technical-deslop
Remove AI-style noise from staged and branch diffs while preserving behavior and repository style.
67technical-skill-finder
Mine coding agent logs (Codex/Cursor/session histories and similar telemetry) to discover high-value candidate skills, then draft structured skill creation/reuse recommendations.
62technical-integrations
Hunt existing integration patterns and design vendor/framework-agnostic API, RFC, SDK, and integration plans for new external vendor integrations.
61opik-optimizer
Optimize LLM prompts, tools, and agents in Opik using standardized optimizer workflows (prompt optimization, tool optimization, and parameter tuning), dataset/metric wiring, and result interpretation.
36example-skill
Template skill for repository authors; excluded from public publishing.
34opik-integrations-auditor
Audit, compare, and document Opik integrations across Python SDK, TypeScript SDK, and OTEL/API backend. Use when adding a new integration, reviewing an existing one, or generating first-pass integration docs and gap analysis.
33