--- title: "documentation-writer by github · skilld" canonical_url: "https://skilld.dev/gh/github/awesome-copilot/documentation-writer" last_updated: "2026-07-29T01:26:02.847Z" meta: description: "Guides creation of software documentation using the Diátaxis framework, which organizes content into four types: tutorials, how-to guides, reference, and explanation.… From github/awesome-copilot." "og:description": "Guides creation of software documentation using the Diátaxis framework, which organizes content into four types: tutorials, how-to guides, reference, and explanation.… From github/awesome-copilot." "og:title": "documentation-writer by github" "twitter:description": "Guides creation of software documentation using the Diátaxis framework, which organizes content into four types: tutorials, how-to guides, reference, and explanation.… From github/awesome-copilot." "twitter:title": "documentation-writer by github" --- [All skills](https://skilld.dev/skills) [![github avatar](https://github.com/github.png?size=96)github/awesome-copilot repository](https://skilld.dev/gh/github/awesome-copilot) # **/documentation-writer** official [github](https://skilld.dev/gh/github)/ [awesome-copilot](https://skilld.dev/gh/github/awesome-copilot) 37,152 4,658 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. Updated 4 hours ago Trust [Documentation](https://skilld.dev/skills/tag/documentation "Docs, changelogs, release notes, READMEs") [ diataxis](https://skilld.dev/skills/tag/diataxis) [ technical-writing](https://skilld.dev/skills/tag/technical-writing) [ tutorials](https://skilld.dev/skills/tag/tutorials) [ how-to-guides](https://skilld.dev/skills/tag/how-to-guides) [ reference](https://skilld.dev/skills/tag/reference) [ explanation](https://skilld.dev/skills/tag/explanation) [ markdown](https://skilld.dev/skills/tag/markdown) [ content-structure](https://skilld.dev/skills/tag/content-structure) ## Skill content ## 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. Source: [SKILL.md on GitHub](https://github.com/github/awesome-copilot/blob/caab1f623bb68a330f294a11279597d7ae7be737/skills/documentation-writer/SKILL.md) ## What it does Guides creation of software documentation using the Diátaxis framework, which organizes content into four types: tutorials, how-to guides, reference, and explanation. The skill structures the writing process through clarification, outline approval, and markdown generation, ensuring documentation is clear, accurate, and user-centric. Based on the current SKILL.md. ## Frequently asked
Does this skill work with any documentation framework, or is it specific to Diátaxis? This skill is specifically built around the Diátaxis framework. It structures documentation into four types (tutorials, how-to guides, reference, explanation) and applies Diátaxis principles throughout the writing process.
What clarifying questions will the skill ask before I start writing? The skill will ask you to define the document type (tutorial, how-to, reference, or explanation), target audience, the user's specific goal, and the scope of topics to include and exclude.
Does this skill generate content directly, or does it require approval first? The skill proposes a detailed outline first and waits for your approval before generating the full documentation.
Can this skill reference existing project documentation for tone and style? Yes. If you provide other markdown files, the skill will use them as context to understand the project's existing tone, style, and terminology—but will not copy content unless explicitly instructed.
Based on the current SKILL.md. These answers refresh after source changes. ## Related skills - [/multi-stage-dockerfilegithub/awesome-copilotCreate optimized multi-stage Dockerfiles for any language or framework](https://skilld.dev/gh/github/awesome-copilot/multi-stage-dockerfile) - [/chrome-devtoolsgithub/awesome-copilotExpert-level browser automation, debugging, and performance analysis using Chrome DevTools MCP. Use for interacting with web pages, capturing screenshots, analyzing network traffic, and profiling performance.](https://skilld.dev/gh/github/awesome-copilot/chrome-devtools) - [/postgresql-optimizationgithub/awesome-copilotPostgreSQL-specific development assistant focusing on unique PostgreSQL features, advanced data types, and PostgreSQL-exclusive capabilities. Covers JSONB operations, array types, custom types, range/geometric types, full-text search, window functions, and PostgreSQL extensions ecosystem.](https://skilld.dev/gh/github/awesome-copilot/postgresql-optimization) - [/conventional-commitgithub/awesome-copilotPrompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation.](https://skilld.dev/gh/github/awesome-copilot/conventional-commit) - [/dotnet-best-practicesgithub/awesome-copilotEnsure .NET/C# code meets best practices for the solution/project.](https://skilld.dev/gh/github/awesome-copilot/dotnet-best-practices) - [/sql-optimizationgithub/awesome-copilotUniversal SQL performance optimization assistant for comprehensive query tuning, indexing strategies, and database performance analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Provides execution plan analysis, pagination optimization, batch operations, and performance monitoring guidance.](https://skilld.dev/gh/github/awesome-copilot/sql-optimization)