write-docs

Write and update user-facing documentation using Diataxis modes with runnable examples.

Updated Sep 3, 2026
One-click install
npx skills add https://github.com/JonusNattapong/A2A-MCP --skill write-docs-jonusnattapong
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/JonusNattapong/A2A-MCP/tree/main/src/agenttalk/skills/devkit/write-docs
Command: npx skills add https://github.com/JonusNattapong/A2A-MCP --skill write-docs-jonusnattapong

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync with code, mixes audience types, and ships examples that do not run. This Skill enforces a disciplined writing workflow so every README, guide, or reference page stays accurate, focused on one reader, and updated in the same change as the code it describes. ## Core Features & Use Cases - Diataxis classification: Forces each page into exactly one mode — tutorial, how-to guide, reference, or explanation — with a named audience and single goal. - Runnable examples first: Requires minimal copy-paste runnable snippets with pinned versions and expected output for any executable example. - Accuracy gate: Mandates updating docs alongside code changes, verifying example output, and passing docs-as-code CI checks like markdownlint, Vale, and link checkers. - Use Case: After changing a CLI flag in your project, use this Skill to rewrite the README quickstart and how-to guide so the documented commands match the new behavior before merging. ## Quick Start Ask the agent to write or update the README quickstart for your project following the write-docs workflow.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I write documentation that stays in sync with code changes?▼

Update docs in the same change as the code they describe, never document unshipped behavior, and run the documented examples to confirm output. This Skill also requires updating changelogs and API references when behavior changes.

What is the Diataxis framework for documentation?▼

Diataxis splits documentation into four modes: tutorials for learning by doing, how-to guides for achieving one goal, reference for exhaustive neutral facts, and explanation for concepts and trade-offs. Each page should use exactly one mode and cross-link instead of mixing.

How should a README be structured for a software project?▼

Follow the README contract: one-line problem statement, minimal example, install and quickstart, usage, link to full docs, contributing, support, then license. Avoid making an FAQ the primary documentation.

When should I not use this documentation writing workflow?▼

Do not use it for inline code comments, which belong to code-writing skills, or for reviewing existing docs, which belongs to a doc review skill. It targets writing or updating user-facing docs tied to code changes.

What CI checks should documentation pass before merging?▼

Run the local docs-as-code gates if present: markdownlint for formatting, a prose and terminology linter like Vale, and a link checker. Also confirm every runnable example produces the documented output.