Agent skill · Code Review & Quality

documentation-writer

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.

GitHub68,948★ · +463/wk · 2 repos on radarProfile →
copilotMIT
Install
npx skills add github/awesome-copilot --skill documentation-writer --agent copilot

Same command for any agent — swap --agent for claude-code, codex, cursor.

Facts
Files in the skill folder: 1
SKILL.md size: 3 KB
Bundled scripts: none
Path: skills/documentation-writer/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 37,432 · +281 this week
Language: Python

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

# 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

What's inside
Steps it walks through
  1. GUIDING PRINCIPLES
  2. YOUR TASK: The Four Document Types
  3. WORKFLOW
  4. CONTEXTUAL AWARENESS
More from awesome-copilot
All skills →
About this skill
What does the documentation-writer skill do?

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.

How do I install it?

Run `npx skills add github/awesome-copilot --skill documentation-writer --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From github/awesome-copilot, a repository with 37,432 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going