skills.rest
Akallabet
AkallabetCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Generate and structure technical documentation using the Diátaxis framework.

Updated Feb 16, 2026
Search Tags:#documentation#technical writing#reference#tutorials#how-to guides#diataxis#explanations
One-click install
npx skills add https://github.com/Akallabet/akallabeth-cc-marketplace --skill documentation-akallabet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/Akallabet/akallabeth-cc-marketplace/tree/main/plugins/ak-documentation/skills/documentation
Command: npx skills add https://github.com/Akallabet/akallabeth-cc-marketplace --skill documentation-akallabet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users create, organize, and improve technical documentation by adhering to the Diátaxis framework, ensuring clarity and effectiveness for different user needs.

Core Features & Use Cases

  • Documentation Type Identification: Guides users to choose between Tutorials, How-to Guides, Reference, and Explanations based on user goals.
  • Structured Content Creation: Provides patterns and best practices for each documentation type.
  • Quality Assurance: Includes validation steps to ensure documentation meets its intended purpose.
  • Use Case: A software team needs to document a new API. This Skill can help them structure the API reference, create tutorials for common use cases, and write explanation pages for complex concepts.

Quick Start

Use the documentation skill to help me structure a tutorial for a new feature.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I structure technical documentation for different user needs?▼

Technical documentation best practices distinguish between how-to guides for practical steps and tutorials for learning, using the Diátaxis framework to ensure how-to guides solve specific user tasks while tutorials focus on guided learning experiences.

How do I differentiate between writing tutorials and how-to guides?▼

Technical documentation best practices distinguish between how-to guides for practical steps and tutorials for learning, using the Diátaxis framework to ensure how-to guides solve specific user tasks while tutorials focus on guided learning experiences.

What is the best way to organize API reference materials and explanations?▼

The best way to organize API reference materials is to separate them from explanations, using the Diátaxis framework to keep reference materials strictly factual while placing conceptual analysis and design decisions into dedicated explanation pages.

Can I use the Diátaxis framework to review and improve existing documentation?▼

Yes, you can use the Diátaxis framework to review existing documentation by applying a validation checklist and type-specific patterns, helping you refine content structure and ensure each page meets its intended purpose.

When should I write an explanation page versus a how-to guide?▼

You should write an explanation page to discuss complex concepts and design decisions, while a how-to guide is appropriate when the user needs practical, step-by-step instructions to achieve a specific working goal.

Related Skills

Explore More Content & Communication Skills→
martiraste-lgtmmartiraste-lgtm

newsletter-writer

Automate drafting and refining Substack newsletter articles from raw notes.

Community
Advanced
Karanjot786Karanjot786
236

documentation-writer

Generate Diátaxis documentation with tutorials, how-tos, reference, and explanations.

Community
Advanced
snake-dev-teamsnake-dev-team

ck:copywriting

Extract writing styles and apply copywriting formulas to emails and landing pages.

Official
Advanced
christopher-busschristopher-buss
6

diataxis

Classify, audit, generate, and restructure documentation into Diátaxis quadrants.

Community
Advanced