documentation-writer

Writes software documentation following the Diátaxis framework's four document types.

3|1|Updated Apr 29, 2026
One-click install
npx skills add https://github.com/firstsun-dev/skills --skill documentation-writer-firstsun-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/firstsun-dev/skills/tree/main/plugins/agent-toolkit/skills/documentation-writer
Command: npx skills add https://github.com/firstsun-dev/skills --skill documentation-writer-firstsun-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Software teams often produce inconsistent, poorly structured documentation that fails to serve its intended audience. This Skill guides an AI agent to act as an expert technical writer, producing documentation that follows the Diátaxis framework so every document has a clear purpose, audience, and structure. ## Core Features & Use Cases - Diátaxis-Based Authoring: Creates content across the four Diátaxis quadrants: Tutorials, How-to Guides, Reference, and Explanation. - Structured Workflow: Clarifies document type, target audience, user goal, and scope before proposing an outline for approval, then generates the full Markdown document. - Context Awareness: Reads existing project Markdown files to match tone, style, and terminology without copying content. - Use Case: Ask the agent to write a beginner tutorial for onboarding new developers to your API; it will confirm the audience and scope, propose a table of contents, and then produce the complete tutorial in Markdown. ## Quick Start Ask the agent to write a how-to guide for deploying your application, and answer its clarifying questions about audience and scope.

Frequently Asked Questions about documentation-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write software documentation using the Diátaxis framework?▼

Classify your document into one of four Diátaxis types: Tutorial, How-to Guide, Reference, or Explanation. Define the target audience and user goal first, then outline the structure before writing the full Markdown content.

What is the difference between a tutorial and a how-to guide?▼

A tutorial is learning-oriented, guiding a newcomer through practical steps to a successful outcome like a lesson. A how-to guide is problem-oriented, providing steps to solve a specific problem like a recipe.

Can the documentation writer match my project's existing style?▼

Yes. When you provide existing Markdown files, the agent uses them as context to understand your project's tone, style, and terminology. It will not copy content from them unless you explicitly ask.

Does the documentation writer generate content without asking questions first?▼

No. The workflow requires clarifying the document type, target audience, user goal, and scope before writing. It then proposes an outline and waits for your approval before generating the full document.

When should I use an explanation document instead of a reference?▼

Use an explanation when readers need to understand a topic conceptually, such as design decisions or architecture discussions. Use reference documentation for information-oriented technical descriptions of machinery, like API parameters or configuration options.