documentation-writer

Writes technical documentation following the Diataxis framework's four document types.

1|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/lrstanley/skills --skill documentation-writer-lrstanley
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/lrstanley/skills/tree/main/documentation-writer
Command: npx skills add https://github.com/lrstanley/skills --skill documentation-writer-lrstanley

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Software projects often ship with inconsistent, poorly structured documentation that confuses users. This Skill produces well-organized technical documentation by applying the Diataxis framework, ensuring each document serves a clear purpose for a defined audience. ## Core Features & Use Cases - Diataxis Document Types: Writes tutorials, how-to guides, reference material, and explanations, each matched to its distinct purpose. - Outline-First Workflow: Clarifies audience, scope, and goals, then proposes a structured outline for approval before writing full content. - Tone Matching: Uses provided Markdown files as context to align with an existing project's tone, style, and terminology. - Use Case: You need a getting-started tutorial for your CLI tool. The Skill asks about your audience and scope, proposes an outline, then writes a learning-oriented tutorial consistent with your existing docs. ## Quick Start Write a how-to guide for configuring authentication in my API, using the attached README for tone and terminology.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I write technical documentation using the Diataxis framework?▼

Diataxis divides documentation into four types: tutorials, how-to guides, reference, and explanation. Identify which type fits your user's goal, then structure the content accordingly. This Skill guides that process by clarifying audience and scope before writing.

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

A tutorial is learning-oriented, guiding a newcomer step by step to a successful outcome. A how-to guide is problem-oriented, giving steps to solve one specific problem for a user who already has some knowledge.

Can this Skill match my existing documentation style?▼

Yes. When you provide existing Markdown files, the Skill reads them to understand tone, style, and terminology, then writes new content consistent with them. It does not copy content from those files unless you explicitly ask.

Does the Skill write documentation immediately without an outline?▼

No. The workflow requires proposing a detailed outline and waiting for your approval before generating full content. This ensures the structure, scope, and document type match your expectations before writing begins.

When should I not use the Diataxis documentation approach?▼

Avoid it when you need a quick one-off note or internal scratch documentation with no defined audience. Diataxis works best for user-facing docs where clarity of purpose, audience, and document type matter.