skills.rest
lluppesms
lluppesmsCOMMUNITY
Explore all skills by this author →
GitHub

documentation-writer

Generate technical documentation in Tutorials, How-to Guides, Reference, and Explanations.

Updated Nov 21, 2025
Search Tags:#documentation#markdown#technical writing#content creation#user guides#diataxis
One-click install
npx skills add https://github.com/lluppesms/dadabase.demo --skill documentation-writer-lluppesms
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/lluppesms/dadabase.demo/tree/main/.github/skills/documentation-writer
Command: npx skills add https://github.com/lluppesms/dadabase.demo --skill documentation-writer-lluppesms

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of creating structured, user-focused technical documentation by adhering to the Diátaxis framework, ensuring clarity, accuracy, and purpose-driven content.

Core Features & Use Cases

  • Diátaxis Framework Adherence: Ensures documentation follows the four core types: Tutorials, How-to Guides, Reference, and Explanations.
  • Structured Workflow: Guides users through a clear process of clarification, outlining, and content generation.
  • Use Case: A software team needs to document a new API. This Skill can help them create a tutorial for new users, a how-to guide for common integration tasks, a reference for API endpoints, and an explanation of the underlying architecture.

Quick Start

Use the documentation-writer skill to create a tutorial for onboarding new developers to 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 technical documentation?▼

The Diátaxis framework structures technical documentation into four distinct types: tutorials, how-to guides, reference materials, and explanations, ensuring user-centric and purpose-driven content creation.

How do I write a user guide for a new API using the Diátaxis framework?▼

To write API user guides, follow a structured workflow of clarification, outlining, and content generation to produce tutorials for onboarding, how-to guides for integration, and reference materials for endpoints.

Can I generate both tutorials and reference materials for the same software project?▼

Yes, you can generate both. The Skill adheres to the Diátaxis framework, allowing you to create tutorials for new developers alongside reference materials for specific software endpoints within the same project.

What's the best way to structure technical documentation for user onboarding?▼

The best way to structure user onboarding documentation is by applying the Diátaxis framework, which separates learning-focused tutorials from action-oriented how-to guides to ensure clarity and accuracy.

Does the documentation generation process require any specific markdown formatting tools?▼

No specific markdown formatting tools are required. The Skill operates independently without dependencies, focusing on the content creation workflow of clarification, outlining, and generating the text.

Related Skills

Explore More Content & Communication Skills→
wizactwizact

spec-context

Parse GitHub issues and project documentation to generate context.json files.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
korchasakorchasa
1

flowai-skill-draw-mermaid-diagrams

Generate Mermaid diagrams inside Markdown and validate syntax against the SPEC.

Community
Intermediate
markacianfranimarkacianfrani
6

diataxis

Classify documentation content into Diátaxis tutorial, how-to, reference, and explanation categories.

Community
Basic