Description
documentation-writer is an agent skill from the github/awesome-copilot collection that acts as a technical writer for software documentation, strictly following the Diátaxis framework. Diátaxis sorts documentation into four distinct types, each with its own purpose: tutorials, which teach a learner by doing; how-to guides, which help a user solve a specific problem; reference, which describes the technical facts precisely; and explanation, which gives the background and reasoning. The skill keeps these types separate, because mixing them, for example putting a long explanation inside a tutorial, is the common cause of documentation that is hard to use. Its guiding principles are clarity, accuracy, user-centricity and consistency: every document should help a specific user achieve a specific task, use simple unambiguous language, keep code snippets and technical details correct and current, and keep tone and terminology the same across the set. The skill is useful for teams building or reorganizing their documentation, and for anyone writing a page who wants to know which kind of page it should be. Documentation has to match the software it describes, so code examples should be run, and the writer should check the details against the current version before publishing. The skill is installed with the skills CLI from the github/awesome-copilot repository. Its skills.sh page showed about 27.4K installs and passing results from three security audits at the time of the scan.…
Highlights
- Diátaxis framework: tutorials, how-to guides, reference and explanation
- Keeps the four document types separate
- Principles of clarity, accuracy, user focus and consistency
- Guidance for technical writing across a documentation set
- Installs with the skills CLI
Ratings & Reviews
No ratings yet
Be the first to rate documentation-writer.
People also visit
verify-openspec-docs
Fact-checks OpenSpec user documentation with a fresh-context subagent
documentation-writer FAQ
What is the Diátaxis framework?
A way of organizing documentation into four types: tutorials, how-to guides, reference and explanation.
Why keep the types separate?
Mixing them, such as putting long explanation inside a tutorial, makes documentation harder to use.
What should a document do?
Help a specific user achieve a specific task, using simple, accurate and consistent language.
Does it check the code?
No. Code snippets should be run and details checked against the current version before publishing.
How do I install it?
Run npx skills add https://github.com/github/awesome-copilot --skill documentation-writer.
What security audits does it have?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Pass.
What are the best documentation-writer alternatives?
Popular alternatives to documentation-writer include hads, technical-writing and draft-openspec-docs. See all documentation-writer alternatives