documentation-writer

Name: documentation-writer
Availability: InStock
Author: hdicko

Guide creation of Diátaxis-compliant software documentation with frontmatter and Markdown.

Updated Aug 18, 2025

Search Tags:#templates #documentation #content-generation #frontmatter #diataxis #outlines

Ready to run

npx skills add https://github.com/hdicko/leidimen --skill documentation-writer-hdicko

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines the creation of structured, high-quality software documentation by guiding authors through the Diátaxis framework to produce tutorials, how-tos, reference material, and explanatory content.

Core Features & Use Cases

Diátaxis-aligned guidance: supports tutorials, how-tos, references, and explanations with consistent tone and structure.
Workflow-assisted authoring: prompts for audience, scope, and document type before drafting, then generates a finalized outline and content.
Template-driven output: provides reusable frontmatter and section templates to accelerate multi-project documentation efforts.

Quick Start

Define the document type, audience, and goal, then approve the outline to generate the full content.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema

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

The Diátaxis framework structures software documentation into four distinct types: tutorials, how-to guides, references, and explanations. This approach separates learning-oriented content from practical task execution, ensuring readers find the right information based on their specific intent.

What's the best way to generate documentation outlines for technical content?▼

Generating documentation outlines works best by first defining the document type, target audience, and specific scope. This workflow-assisted approach prompts authors for these foundational details before drafting, ensuring the finalized outline aligns precisely with the intended documentation structure.

Can I use frontmatter templates for multi-project documentation efforts?▼

Yes, frontmatter templates support reusable documentation across multiple projects. These templates enforce a consistent schema requiring a name and description, while also providing standardized section templates to accelerate content generation and maintain uniform metadata across various software products.

Does Diátaxis documentation support including optional assets and scripts?▼

Diátaxis documentation supports optional assets, scripts, and references for extensible docs. While the Markdown body is mandated for activation and frontmatter enforces the core schema, these optional components allow authors to attach supplementary technical material directly to the documentation.

When should I use a how-to guide instead of a tutorial in software documentation?▼

Use a how-to guide when a reader needs to accomplish a specific practical task and already possesses basic knowledge. Tutorials are reserved for learning-oriented scenarios where the audience needs guided steps to understand concepts, whereas how-tos focus strictly on practical problem-solving.