Source profileQuality 66/100

github/awesome-copilot/skills/documentation-writer/SKILL.md

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.

Source repository stars
37,126
Declared platforms
0
Static risk flags
0
Last source update
2026-07-28
Source checked
2026-07-28
DecisionCompatibilityInstallWorkflowPermissionsEvidenceSource

Decision brief

What it does—and where it fits

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/).

Best for

    Not for

    • Tasks that require unconfirmed production actions or broad system permissions.
    • Environments where the pinned source and install steps cannot be inspected.

    Compatibility matrix

    Platform support, with evidence labels

    PlatformStatusEvidenceWhat to check
    CodexNot declaredNo explicit evidencePortability before use
    Claude CodeNot declaredNo explicit evidencePortability before use
    CursorNot declaredNo explicit evidencePortability before use
    Gemini CLINot declaredNo explicit evidencePortability before use
    Open the compatibility checker

    Installation

    Inspect first. Install second.

    The source command is displayed only when detected. A safe inspection prompt is always available so your agent can explain every action before execution.

    Source-detected install commandSource
    npx skills add https://github.com/github/awesome-copilot --skill "skills/documentation-writer"
    Safe inspection promptEditorial

    Inspect the Agent Skill "documentation-writer" from https://github.com/github/awesome-copilot/blob/9933dcad5be5caeb288cebcd370eeeb2fc2f1685/skills/documentation-writer/SKILL.md at commit 9933dcad5be5caeb288cebcd370eeeb2fc2f1685. List every install step, command, network request, credential, file read/write, external action, and rollback step. Explain whether it fits my task. Do not install or execute anything until I approve.

    Workflow

    What the source asks the agent to do

    1. 01

      WORKFLOW

      You will follow this process for every documentation request:

      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)
    2. 02

      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…

      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.
    3. 03

      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.
    4. 04

      CONTEXTUAL AWARENESS

      When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.

      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.

    Permission review

    Static risk signals and limitations

    No configured static risk pattern was detected

    This is not proof of safety. Runtime behavior, indirect dependencies, and hidden external systems are outside the static scan.

    Evidence record

    Why each signal appears

    EvidenceSourceComputedTestedEditorial
    SignalValueEvidence typeMeaning
    Quality score66/100ComputedDocumentation, specificity, maintenance, and trust rules
    Repository stars37,126SourceRepository attention, not individual Skill quality
    Compatibility0 platformsSourceDeclared in the catalog source record
    Usage guideautomated source guideEditorialGenerated or reviewed according to the visible evidence level

    Pinned source

    Provenance and original SKILL.md

    Repository
    github/awesome-copilot
    Skill path
    skills/documentation-writer/SKILL.md
    Commit
    9933dcad5be5caeb288cebcd370eeeb2fc2f1685
    License
    MIT
    Collected
    2026-07-28
    Default branch
    main
    View the original 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

    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.

    Alternatives

    Compare before choosing

    Computed 9731,966

    K-Dense-AI/scientific-agent-skills

    biopython

    Comprehensive molecular biology toolkit. Use for sequence manipulation, file parsing (FASTA/GenBank/PDB), phylogenetics, and programmatic NCBI/PubMed access (Bio.Entrez). Best for batch processing, custom bioinformatics pipelines, BLAST automation. For quick lookups use gget; for multi-service integration use bioservices.

    2026-07-280 platforms
    Computed 9531,966

    K-Dense-AI/scientific-agent-skills

    markdown-mermaid-writing

    Comprehensive markdown and Mermaid diagram writing skill. Use when creating any scientific document, report, analysis, or visualization. Establishes text-based diagrams as the default documentation standard with full style guides (markdown + mermaid), 24 diagram type references, and 9 document templates.

    2026-07-280 platforms
    Computed 9510,762

    Jeffallan/claude-skills

    fastapi-expert

    Use when building high-performance async Python APIs with FastAPI and Pydantic V2. Invoke to create REST endpoints, define Pydantic models, implement authentication flows, set up async SQLAlchemy database operations, add JWT authentication, build WebSocket endpoints, or generate OpenAPI documentation. Trigger terms: FastAPI, Pydantic, async Python, Python API, REST API Python, SQLAlchemy async, JWT authentication, OpenAPI, Swagger Python.

    2026-05-200 platforms
    Computed 9438,313

    wshobson/agents

    brand-landingpage

    Brand-first landing page designer — runs a brand-identity interview (colors, typography, shape language), then generates and iterates on a polished landing page via Stitch with deployment-ready HTML. Use when the user asks to create, design, or build a landing page, homepage, or marketing page and has no established visual direction. Skip when they have a design mockup, need a dashboard or app UI, are working at component level, building a multi-page app, or restyling with known design tokens —

    2026-07-220 platforms