documentation-writer (github/awesome-copilot): a skill that writes docs using the Diátaxis framework

documentation-writer makes your agent act as a technical writer: it asks what you need, proposes an outline, then writes the doc in Markdown.

Installs: 28.1K; on skills.sh
Stars: 40.7K; on GitHub
Updated: Oct 2026; last repo commit

The skill sets the agent up as an expert in the Diátaxis framework, which splits documentation into four types: tutorials, how-to guides, reference and explanation. It follows a three-step workflow. First it asks clarifying questions, then proposes an outline and waits for your approval, then writes the full document in Markdown.

It must find out four things before it starts: the document type, the target audience, the reader's goal and the scope. It uses markdown files you provide to match your tone and terminology, and says not to copy from them. It will not consult outside websites unless you give a link and ask. SKILL.md is a short file of instructions that bundles no scripts.

Good for

Developers writing docs for a library, API or internal tool
Technical writers who want a consistent doc structure
Teams that want docs sorted into tutorials, how-tos, reference and explanation

Install documentation-writer

Claude Code

Copy this prompt.

Install the documentation-writer skill in Claude Code. Run this command:

npx skills add https://github.com/github/awesome-copilot --skill documentation-writer

Then check that it loaded and tell me how to use it.

2
Paste it into Claude Code. It shows the change and asks before running it.

Requires Node.js.

From its listing on skills.sh. Source.

What's in the skill

When it loads

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.

Sections in SKILL.md

GUIDING PRINCIPLES
YOUR TASK: The Four Document Types
WORKFLOW
CONTEXTUAL AWARENESS

Key facts

Author: Listed in github/awesome-copilot, a community collection (author not named in SKILL.md)
Repo: github/awesome-copilot, path skills/documentation-writer
Installs on skills.sh: 28,055 (as of Nov 2, 2026)
GitHub stars: 40,666 (shared repo, Nov 2, 2026)
License: MIT (from crawl data)
Last repo commit: Oct 30, 2026
skills.sh audits: Gen Agent Trust Hub: pass. Socket: pass. Snyk: pass.
Files: 1: SKILL.md only
Framework: Diátaxis (diataxis.fr)

What it includes

Asks for document type, audience, reader goal and scope
These four answers are required before the agent goes on.
Step 1: acknowledge and clarify
Offers an outline and waits for your approval
A table of contents with a short description of each section.
Step 2: propose a structure
Writes the full document in Markdown
Follows four principles: clarity, accuracy, user-centricity and consistency.
Write · Step 3: generate content
Learning-oriented steps for a newcomer
Described as a lesson.
Tutorial
Problem-oriented steps for one task
Described as a recipe.
How-to guide
Information-oriented technical description
Described as a dictionary.
Reference
Understanding-oriented discussion of a topic
Described as a discussion.
Explanation
Reads your markdown files for tone
Does not copy from them unless you ask, and does not use outside sources unless you give a link.
Read · Context rules

From the official docs

Questions

What does documentation-writer do?

It makes your agent write documentation using the Diátaxis framework. It asks about the document type, audience, goal and scope, proposes an outline, and writes the Markdown after you approve.

How do I install it in Claude Code?

Use the install command in the box above. The awesome-copilot catalog also lists gh skills install github/awesome-copilot documentation-writer for GitHub's CLI.

What is Diátaxis?

A documentation framework that sorts content into tutorials, how-to guides, reference and explanation. SKILL.md links to diataxis.fr as its source.

Does it need an API key or scripts?

No script or key is bundled; the skill is one SKILL.md file. It uses the files you give it and, per SKILL.md, no outside sources unless you provide a link.

Is it safe?

It is one SKILL.md file with no bundled scripts. It can read markdown files you point it to and writes the document it produces. The awesome-copilot README says its items come from third-party developers, so read the file before installing.

Will it start writing right away?

No. SKILL.md says it must ask clarifying questions first and wait for your approval of the outline before it writes the full content.

Does it work in Codex, Cursor or Copilot?

The skill is plain instructions in the standard SKILL.md format. The repo is built for GitHub Copilot, and neither the repo README nor SKILL.md lists other clients.

Information

updated Nov 2, 2026

Repository: github/awesome-copilot
Folder: skills/documentation-writer

github/awesome-copilot skills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 3

SKILL.md · github.com
awesome-copilot skills catalog · github.com
awesome-copilot README · github.com