Documentation Writer

The documentation-writer skill enables technical writers and software developers to create structured, user-focused documentation using the Diátaxis Framework, which organizes content into tutorials, how-to guides, reference materials, and explanations. It guides users through a three-step workflow that clarifies document purpose and audience, proposes an outline for approval, and generates well-formatted Markdown content while maintaining consistency in tone and terminology. This skill solves the problem of producing scattered or unfocused documentation by providing a systematic approach rooted in proven principles of technical writing.

install copies · 90 days. Times the install command was copied on this site in the last 90 days, bots filtered.: 104
skills.sh installs: 28.4K
GitHub stars: 41K
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add github/awesome-copilot --skill documentation-writer --agent claude-code

Installs into .claude/skills of the current project.

Files

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

Clarity: Write in simple, clear, and unambiguous language.
Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
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.

SKILL.md on GitHub