documentation-writer

Generate Diátaxis Framework software documentation in Markdown.

1|Updated Dec 22, 2025

Search Tags:#documentation #markdown #technical writing #tutorials #diataxis #developer guides

Ready to run

npx skills add https://github.com/dhar174/langgraph_system_generator --skill documentation-writer-dhar174

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/dhar174/langgraph_system_generator/tree/main/.github/skills/documentation-writer
Command: npx skills add https://github.com/dhar174/langgraph_system_generator --skill documentation-writer-dhar174

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of creating high-quality, structured software documentation that effectively guides users through learning, problem-solving, reference, and understanding.

Core Features & Use Cases

Diátaxis Framework Adherence: Ensures documentation follows best practices for clarity, accuracy, and user-centricity.
Four Document Type Specialization: Generates Tutorials, How-to Guides, Reference materials, and Explanations tailored to specific user needs.
Structured Workflow: Guides users through a clear process of clarification, outline proposal, and content generation.
Use Case: A development team needs to document a new API. This Skill can generate a comprehensive set of tutorials for new users, how-to guides for common integration tasks, reference documentation for each endpoint, and explanations of core concepts.

Quick Start

Use the documentation-writer skill to create a tutorial for new developers on setting up the project.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

What is the Diátaxis framework for software documentation?▼

The Diátaxis framework structures software documentation into Tutorials, How-to Guides, Reference materials, and Explanations. It aligns content with user goals for learning, problem-solving, reference, and understanding.

How do I generate API reference documentation in Markdown?▼

Generate API reference documentation in Markdown through a structured workflow of clarification, outline proposal, and content generation. This produces reference materials tailored to specific user needs and target audiences.

How do I write tutorials for new developers onboarding to a project?▼

Write tutorials for new developers by specifying learning goals and target audiences. The generation process creates Markdown tutorials aligned with Diátaxis principles to guide users step-by-step.

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

In Diátaxis, Tutorials focus on learning by guiding beginners through practical steps, while How-to Guides focus on achieving specific goals for users who know the basics. Both are generated as Markdown content.

Can I create developer guides for different target audiences using the same tool?▼

Create developer guides for different target audiences by specifying user goals during the clarification step. The workflow generates tailored Markdown content suited for varying technical levels and needs.

Does automated documentation generation work for explaining core technical concepts?▼

Automated documentation generation works for explaining core concepts by producing the Explanation document type from the Diátaxis framework. It generates Markdown content that deepens understanding of specific technical topics.