Agent skill · magnus919
technical-documentation
Create and review technical documentation, including READMEs, agent-facing instructions, API references, and CLI help. Use when documentation must help someone complete real work. Do not use for marketing copy, brand messaging, or long-form editorial content.
What it needs
About 2k tokens when loaded.
What this skill does
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 Reference When to load ----------- ------------- references/readme-patterns.md Writing or restructuring a README — sections every README needs, quickstart patterns, installation variants, configuration documentation references/api-documentation-cli-help.md Documenting APIs (endpoint structure, parameter conventions, example design, auth patterns, OpenAPI annotations) and designing CLI help text (usage line, flags, exit codes, subcommand hierarchy, man pages) references/agent-facing-docs.md Writing AGENTS.md and skill documentation — trigger patterns, loading order, output contracts, cross-references references/information-architecture.md Structuring a documentation site — progressive disclosure, cross-referencing, search optimization, maintenance strategy Related Skills documents — producing office-format deliverables (PDF …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills magnus919/technical-documentation