Diátaxis Documentation Expert

documentation-writer

Expert technical writer for Diátaxis-framework documentation creation across tutorials, how-to guides, reference, and explanation formats.

github/awesome-copilot·27.3Kinstalls39.7KstarsDocumentation

SKILL.md

Full skill instructions

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.

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)
- User's Goal: What does the user want to achieve by reading this document?
- Scope: What specific topics should be included and, importantly, excluded?
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.
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.

Install skill

Copy and run in your terminal

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

View on GitHub

documentation-writer

More Documentation skills

View all

Documentation

lark-wiki

Manage Lark Wiki spaces, members, nodes, and document organization hierarchies.

17.5K 457.5K

View

Documentation

lark-openapi-explorer

Discover and call native Lark OpenAPI endpoints from official documentation when existing skills fall short.

17.5K 451K

View

Documentation

supabase-postgres-best-practices

Postgres performance optimization and best practices from Supabase. Use this skill when writing, reviewing, or optimizing Postgres queries, schema designs, or database configurations.

2.7K 431.1K

View

Documentation

writing-beats

writing beats

276.6K 414.7K

View

Documentation

writing-shape

writing shape

276.6K 414.2K

View

Documentation

writing-fragments

writing fragments

276.6K 413.9K

View

Documentation

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K

View

Documentation

writing-skills

Test-driven documentation for creating reusable agent techniques, patterns, and reference guides.

295.4K 205.7K

View

Documentation

firebase-auth-basics

Guide for setting up and using Firebase Authentication. Use this skill when the user's app requires user sign-in, user management, or secure data access using auth rules.

462 163.8K

View

Documentation

firebase-data-connect

Builds and deploys Firebase SQL Connect (aka Firebase Data Connect) backends with PostgreSQL securely. Use when designing schemas with tables and relations, writing authorized queries and mutations, configuring real-time data updates, or generating type-safe SDKs. Use when you need a relational database with Firebase, or when the user mentions SQL Connect or Data Connect.

462 158.3K

View

Documentation

vercel-react-view-transitions

Guide for implementing smooth, native-feeling animations using React's View Transition API (`<ViewTransition>` component, `addTransitionType`, and CSS view transition pseudo-elements). Use this skill whenever the user wants to add page transitions, animate route changes, create shared element animations, animate enter/exit of components, animate list reorder, implement directional (forward/back) navigation animations, or integrate view transitions in Next.js. Also use when the user mentions view transitions, `startViewTransition`, `ViewTransition`, transition types, or asks about animating between UI states in React without third-party animation libraries.

31.9K 143K

View