diataxis-doc-generator

Solid

Generate documentation following the Diataxis framework

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
95
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Diataxis Documentation Generator Skill ## Overview This skill generates comprehensive documentation following the Diataxis framework, organizing content into tutorials, how-to guides, reference, and explanation categories for optimal developer learning. ## Capabilities - Structure documentation as tutorials, how-to guides, reference, explanation - Generate progressive getting started guides - Create interactive API reference documentation - Build code example repositories with multiple languages - Implement documentation versioning - Configure search and navigation - Generate documentation from code comments - Support multiple documentation platforms ## Target Processes - API Documentation System - SDK Onboarding and Tutorials - Developer Experience Optimization ## Integration Points - Docusaurus for React-based docs - ReadTheDocs for Python projects - Mintlify for modern documentation - GitBook for collaborative docs - MDX for interactive components ## Input Requirements - API specification or source code - Target audience profiles - Documentation platform preference - Branding and style guidelines - Code example requirements ## Output Artifacts - Structured documentation site - Tutorial sequences - How-to guide collection - API reference pages - Explanation articles - Code examples repository - Navigation configuration ## Usage Example ```yaml skill: name: diataxis-doc-generator context: apiSpec: ./openapi.yaml platform: docusaurus languages:...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills