--- title: "Diataxis Documentation Writer: review, setup & limitations · Undominated.ai" canonical: https://undominated.ai/skills/github-documentation-writer/ description: "Writes docs under Diataxis discipline: clarify the quadrant, audience, goal and scope first, approve an outline, then draft tutorials, how-tos, reference or explanation in project tone." --- # Diataxis Documentation Writer: review, setup & limitations · Undominated.ai > Writes docs under Diataxis discipline: clarify the quadrant, audience, goal and scope first, approve an outline, then draft tutorials, how-tos, reference or explanation in project tone. [← Explore all skills](/skills/) RESEARCH AND DOCUMENTATION / GitHub community # Diataxis Documentation Writer Writes docs under Diataxis discipline: clarify the quadrant, audience, goal and scope first, approve an outline, then draft tutorials, how-tos, reference or explanation in project tone. [See setup guidance ↓](#setup)[Original source ↗](https://github.com/github/awesome-copilot/tree/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer) SOURCE REVIEW Reviewed 2026-10-15 Evidence 6 linked sources Publisher GitHub community Licence [MIT ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/LICENSE) Revision 3a685010a7af [Read what was—and wasn’t—checked ↓](#review) “Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.” [GitHub community · upstream description ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer/SKILL.md) Our analysis follows below. 01 / THE REASONING ## Why this made the selection. - The quadrant gate (tutorial, how-to, reference, explanation) plus a mandatory outline-approval step stops documentation from being written before its purpose and scope are agreed. - Contextual-awareness rules treat project files as tone context that must not be copied, and forbid external browsing unless the user supplies a link. ### A good fit for - Structuring a new documentation set into Diataxis quadrants - Turning scattered notes into scoped, audience-specific guides - Agree a document type, audience, goal, exclusions, and outline before drafting the full Markdown content. ### Weigh up before choosing - Framework-first and deliberately procedural; overkill for one-paragraph answers and small edits. - Code-sample accuracy still needs verification against the repository since the workflow clarifies and drafts but never executes code. - The definition restricts external-source consultation to links the user supplies with an instruction to consult them. 02 / THE REVIEW RECORD ## What we actually inspected. Source review has boundaries. A clear record is more useful than a “safe” badge. ### Material inspected - skills/documentation-writer/SKILL.md - LICENSE - SKILL.md and LICENSE re-read at 3a685010 on 2026-10-13 for the downloadable definition; both byte-identical at HEAD 156736fb (git blob SHAs). - vercel-labs/skills@7407f3893ad4dceab546ac002c3ef806e4000c73:README.md ### Our findings - The workflow separates acknowledge-and-clarify, propose-structure and generate-content into gated phases with defined inputs for each. - Guiding principles name clarity, accuracy, user-centricity and consistency as the checks applied to every draft. - The no-external-sources default bounds the skill to user-provided material and project context. - The workflow requires outline approval before full drafting and treats supplied Markdown as tone and terminology context rather than content to copy without an explicit request. ### Not established by this review - No documentation was drafted with this skill. - Outline gating and quadrant classification were not observed in use. - Not executed: it was not installed or run. The review applies to the material and revision named here. A newer upstream release can change its behavior. 03 / PUT IT TO WORK ## Add a skill to your workflow. [Upstream setup instructions ↗](https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/README.md) DOCUMENTED COMMAND npx skills add github/awesome-copilot/skills/documentation-writer --skill documentation-writer Copy command ↗ Run in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above. Optional: install the reviewed revision Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose. npx skills add https://github.com/github/awesome-copilot/tree/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer --skill documentation-writer Copy reviewed-revision command ↗ - Install the complete skill directory; select your AI tools and project or global scope. - Review the instructions before invoking them. The source revision shown here is the one reviewed; the installer was not executed or version-pinned by this review. - For manual installation instead, download the complete bundle from https://undominated.ai/resources/skills/github-documentation-writer/bundle.zip and extract it into a new directory. It holds SKILL.md unchanged at revision 3a685010, the upstream licence and an attribution file. - Place the extracted directory in your host's documented skills directory, named documentation-writer. Keep SKILL.md and the licence together. ### Before you start - Node.js/npm and git for the documented Skills installer - An agent host that supports the skill format - Source material and a named audience for the document ### Compatibility Agent Skills-compatible coding agents · Markdown documentation projects with reviewable outlines ### Document reads and markdown drafts - Read project markdown for tone and terminology context - Draft new markdown documents when authorized - No external fetching unless the user provides a link ### Cost model The skill is MIT-licensed; agent calls remain separate. THE COMPLETE REVIEWED DEFINITION ## Read it before you reuse it. Original source bytes, with attribution. Review the host-specific setup notes above. Copy definition ↗ [Download definition + licence ↗](/resources/skills/github-documentation-writer/bundle.zip)[Raw Markdown ↗](/resources/skills/github-documentation-writer/definition.md) --- name: documentation-writer description: 'Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.' --- # Diátaxis Documentation Expert You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/). ## GUIDING PRINCIPLES 1. **Clarity:** Write in simple, clear, and unambiguous language. 2. **Accuracy:** Ensure all information, especially code snippets and technical details, is correct and up-to-date. 3. **User-Centricity:** Always prioritize the user's goal. Every document must help a specific user achieve a specific task. 4. **Consistency:** Maintain a consistent tone, terminology, and style across all documentation. ## YOUR TASK: The Four Document Types You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each: - **Tutorials:** Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson. - **How-to Guides:** Problem-oriented, steps to solve a specific problem. A recipe. - **Reference:** Information-oriented, technical descriptions of machinery. A dictionary. - **Explanation:** Understanding-oriented, clarifying a particular topic. A discussion. ## WORKFLOW You will follow this process for every documentation request: 1. **Acknowledge & Clarify:** Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding: - **Document Type:** (Tutorial, How-to, Reference, or Explanation) - **Target Audience:** (e.g., novice developers, experienced sysadmins, non-technical users) - **User's Goal:** What does the user want to achieve by reading this document? - **Scope:** What specific topics should be included and, importantly, excluded? 2. **Propose a Structure:** Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content. 3. **Generate Content:** Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles. ## CONTEXTUAL AWARENESS - When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology. - DO NOT copy content from them unless I explicitly ask you to. - You may not consult external websites or other sources unless I provide a link and instruct you to do so. The download contains SKILL.md . Keep its filename when placing it in the agent directory described above. By **GitHub community**. [Exact upstream source ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer/SKILL.md) · [Licence](/resources/skills/github-documentation-writer/LICENSE.txt) · [Attribution](/resources/skills/github-documentation-writer/ATTRIBUTION.txt) SHA-256 7e8244988c9f4eb63bf8c0edf160578544621eb96e5e51e2d848f1401c5de8f1 Read the applicable licence MIT License Copyright GitHub, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 04 / FOLLOW THE EVIDENCE ## The source trail. Our notes are separate from the original resource. Check upstream before adopting a new version. - [Skill definition at reviewed revision ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer/SKILL.md) Checked 2026-10-13 https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer/SKILL.md Supports: summary, upstreamDescription, whySelected, bestFor, limitations, review, compatibility, access - [Upstream license or licensing declaration ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/LICENSE) Checked 2026-10-13 https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/LICENSE Supports: license - [Publisher installation and project documentation ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/README.md) Checked 2026-10-07 https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/README.md Supports: install, compatibility, access - [Skills installer source formats and selective installation ↗](https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/README.md) Checked 2026-10-07 https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/README.md Supports: install - [Installer implementation: full commit SHA fallback ↗](https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/src/git.ts) Checked 2026-10-07 https://github.com/vercel-labs/skills/blob/7407f3893ad4dceab546ac002c3ef806e4000c73/src/git.ts Supports: install - [Pinned continuation review W18 ↗](https://raw.githubusercontent.com/github/awesome-copilot/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer/SKILL.md) Checked 2026-10-15 https://raw.githubusercontent.com/github/awesome-copilot/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/skills/documentation-writer/SKILL.md Supports: review.findings, bestFor, limitations KEEP COMPARING ## Other approaches to consider. Related by category or shared topics. These are alternatives to inspect, not a measured quality order. [### Anthropic Documentation Coauthoring ↗ Guides a human and agent through audience discovery, section-by-section drafting and a separate-reader review of a substantial document.](/skills/anthropics-doc-coauthoring/)[### Microsoft Docs Research ↗ Finds current Microsoft documentation with task-specific queries and retrieves full pages when excerpts are insufficient.](/skills/microsoft-microsoft-docs/)[### Microsoft Wiki Researcher ↗ Traces architecture and data flow through source code to produce an explanation with file references, diagrams and stated uncertainties.](/skills/microsoft-wiki-researcher/) [AI Tools ↗](/tools/)[Skills ↗](/skills/)[Agents ↗](/agents/)[MCP Servers ↗](/mcp-servers/)[Workflows ↗](/workflows/) ## Continue your investigation - [Choose a toolkit](/tools/) - [Inspect execution hosts](/agents/) - [Check tool access](/mcp-servers/) - [Check project dependencies](/check-repo/)