documentation-writer

Generate Diátaxis-structured software documentation with YAML frontmatter.

2|Updated Apr 2, 2026

Search Tags:#documentation #markdown #diataxis #technical-writing #content-structure #documentation-workflow

Ready to run

npx skills add https://github.com/kaone31056789/KritakaPrajna --skill documentation-writer-kaone31056789

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces structured, high-quality software documentation by applying the Diátaxis framework, ensuring consistency across tutorials, how-tos, references, and explanations.

Core Features & Use Cases

Diátaxis-guided templates for Tutorials, How-to Guides, Reference, and Explanation documents.
Frontmatter-driven metadata to support discovery and indexing while keeping the content machine-friendly.
Context-aware drafting workflow that asks clarifying questions before generating a complete, ready-to-publish doc.

Quick Start

Provide a topic and audience, and I will generate a complete Diátaxis-based documentation draft with structured sections.

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 four distinct quadrants: tutorials, how-to guides, reference, and explanations. It ensures audience-centric language by separating learning goals from practical work steps and technical descriptions.

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

To write technical documentation using Diátaxis, provide a topic and audience. The workflow asks clarifying questions, enforces a four-quadrant content structure, and generates a complete draft with YAML frontmatter containing name and description metadata.

Does the Diátaxis documentation method work for any technical topic?▼

Yes, the Diátaxis documentation method applies across tutorials, how-to guides, reference, and explanations for any technical topic. It adapts to the specific subject matter while maintaining a consistent, audience-centric structure throughout the generated content.

What's the best way to structure markdown documentation for software projects?▼

The best way to structure markdown documentation is applying the Diátaxis framework. This approach divides content into four quadrants—tutorials, how-to guides, reference, and explanations—ensuring high-quality, consistent documentation that serves different user needs effectively.

Why does documentation need YAML frontmatter with name and description?▼

Documentation requires YAML frontmatter with name and description to support discovery and indexing. This frontmatter-driven metadata keeps the content machine-friendly while ensuring the structured software documentation remains organized and easily retrievable across documentation workflows.

When should I not use a four-quadrant documentation structure?▼

A four-quadrant Diátaxis documentation structure may not suit projects needing unstructured narratives or single-page quick references. It is designed for comprehensive software documentation requiring strict separation between tutorials, how-to guides, reference, and explanations for distinct audiences.