skills.rest
mi179
mi179COMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-generate

Generate Diataxis documentation with tutorials, how-tos, references, and explanations in Markdown.

1|Updated May 27, 2026
Search Tags:#documentation#reference#how-to#explanation#tutorial#generate#diataxis
One-click install
npx skills add https://github.com/mi179/claude-skills --skill document-generate-mi179
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-generate
Source: https://github.com/mi179/claude-skills/tree/main/user/gstack/document-generate
Command: npx skills add https://github.com/mi179/claude-skills --skill document-generate-mi179

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation for new features and modules is often missing, inconsistent, or delayed. This Skill fills gaps by generating complete guides using a Diataxis framework, ensuring consistent structure and rapid material for onboarding, reference, and tutorials.

Core Features & Use Cases

  • Generates tutorials, how-tos, references, and explanations from a feature description.
  • Produces structured Markdown with a YAML frontmatter block and contextual content suitable for onboarding, handbooks, and knowledge bases.
  • Use case: when a new feature is introduced or a project lacks up-to-date documentation, run this skill to auto-create a full documentation package.

Quick Start

Create a complete documentation package for a new feature using the Diataxis format.

Frequently Asked Questions about document-generate

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

FAQPage Schema
How do I generate documentation for a new feature using the Diataxis framework?▼

To generate documentation using the Diataxis framework, provide a feature description and the skill outputs structured Markdown covering tutorials, how-tos, references, and explanations ready for your knowledge base.

What is the Diataxis framework for writing technical documentation?▼

The Diataxis framework is a documentation structure that categorizes content into four modes: tutorials, how-to guides, references, and explanations, ensuring comprehensive coverage for onboarding and knowledge bases.

Can I auto-generate Markdown documentation with YAML frontmatter for onboarding?▼

Yes, you can auto-generate Markdown documentation with YAML frontmatter containing name and description fields, producing structured content suitable for onboarding handbooks and feature releases.

Does this documentation generation approach work for existing codebases lacking up-to-date guides?▼

Yes, this approach works for existing codebases lacking up-to-date guides by filling documentation gaps and generating consistent reference materials, how-tos, and tutorials from project or module descriptions.

What is the best way to create a complete documentation package for a module release?▼

The best way to create a documentation package for a module release is to apply the Diataxi framework, which auto-creates structured Markdown spanning tutorials, references, and explanations from the feature description.

Related Skills

Explore More Software Engineering Skills→
TairitsuaTairitsua
13

mo-docs-authoring

Generate zh-CN Monica module documentation from repository source files.

Community
Intermediate
praburajasekaranpraburajasekaran

compound-docs

Document solved problems as structured Markdown files with YAML frontmatter metadata.

Community
Advanced
ActiveInferenceInstituteActiveInferenceInstitute
30

gnn-parsing

Parse GNN Markdown files and serialize structured model data to JSON, YAML, and XML.

Community
Advanced
d-padmanabhand-padmanabhan
15

documentation-standards

Enforce Markdown, Mermaid, and technical-writing conventions for documentation.

Community
Basic