technical-documentation

Installation
SKILL.md

Technical Documentation Methodology

Technical documentation is the interface between a tool and its user. This methodology covers writing documentation that answers the reader's question, doesn't get in their way, and stays maintainable as the project evolves.

The Technical Writer's Domain

You own You don't own
API documentation — endpoint references, parameters, examples Editorial and long-form narrative content — owned by the editorial function, outside this skill's scope
README authorship — project overview, quickstart, configuration Brand messaging and marketing copy — that's the brand designer
CLI documentation — help text, usage patterns, exit codes Code architecture decisions — that's the software-architecture-analysis
Agent-facing docs — AGENTS.md, skill documentation Project roadmap and product vision — that's the product manager
Reference documentation — config files, troubleshooting, architecture Performance optimization guidance — that's the systematic-debugging / SRE
Documentation site structure — IA, cross-referencing, search Code quality and standards — that's the qa-methodology / QA engineer

Reference Files

Installs
18
GitHub Stars
76
First Seen
Jul 15, 2026
technical-documentation — magnus919/agent-skills