documentation-writer

Name: documentation-writer
Availability: InStock
Author: shysssthanhtri

Create Markdown technical documentation using the Diátaxis framework.

Updated Mar 19, 2026

Search Tags:#documentation #reference #docs #how-to #tutorials #diataxis #technical-writing

Ready to run

npx skills add https://github.com/shysssthanhtri/AI-tools --skill documentation-writer-shysssthanhtri

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates inconsistent, unfocused, or unclear project documentation by applying the Diátaxis framework to produce task-oriented tutorials, how-to guides, reference pages, and explanatory articles that meet reader goals.

Core Features & Use Cases

Structured authoring workflow: Guides the writer through clarification, outline proposal, approval, and final Markdown generation steps.
Four-quadrant outputs: Produces Tutorials, How-to Guides, Reference pages, and Explanations tailored to specified audiences and goals.
Use Case: For a library maintainer onboarding contributors, produce a Diátaxis-aligned contributor tutorial, a troubleshooting how-to, and concise API reference pages that match the project's existing tone.

Quick Start

Use the documentation-writer skill to draft a Diátaxis-style how-to guide for onboarding new contributors to my project.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

How do I structure technical documentation using the Diátaxis framework?▼

Technical documentation using the Diátaxis framework is structured into four distinct quadrants: task-oriented tutorials, step-by-step how-to guides, concise reference material, and explanatory articles. This approach ensures content meets specific reader goals.

What is the best way to write a contributor onboarding tutorial for a software project?▼

The best way to write a contributor onboarding tutorial is to follow a structured authoring workflow that clarifies audience and scope, proposes an outline for approval, and generates final Markdown documentation tailored to your project's existing tone.

Can I generate how-to guides and API reference pages in Markdown format?▼

Yes, you can generate how-to guides and API reference pages in Markdown format. The documentation workflow produces final Markdown documentation adhering to Diátaxis principles for both developer and end-user audiences.

How do I create a documentation outline for approval before writing the final content?▼

To create a documentation outline for approval, the workflow guides you through clarifying audience, scope, and user goals first, then produces a proposed outline for your review before generating the final Markdown documentation.

When do I need to separate tutorials from reference material in project documentation?▼

You need to separate tutorials from reference material when addressing different reader goals, such as learning versus looking up specific information. The Diátaxis framework eliminates unfocused documentation by matching content types to these distinct learning modes.