skilld
All skills
github avatar

/documentation-writer

@caab1f6 official
by githubgithub/awesome-copilot40k stars
5,040

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.

Ask your Agent

Use this Skill: https://skilld.dev/gh/github/awesome-copilot/documentation-writer

This session only. Nothing lands on disk.

SKILL.md

≈61 tokens always: the name and description. ≈619 when used: this file.

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

Third-party checks

1 warning16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill is a specialized technical writing assistant based on the Diátaxis framework and contains no malicious code, dangerous execution patterns, or security vulnerabilities.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer7mo

    1/1 file flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at caab1f6. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 19 hours ago.

Activeupdated 7 months ago

Topics

  • Documentation
  • diataxis
  • technical-writing
  • tutorials
  • how-to-guides
  • reference
  • explanation
  • markdown
  • content-structure

README badge

README badge for github/awesome-copilot/documentation-writer

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.

Generated from 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.

Generated from the current SKILL.md. These answers refresh after source changes.