Diataxis Doc Generator

Documents

diataxis-doc-generator

Diataxis Doc Generator is an Agent Skill for documents published in the a5c-ai/babysitter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Generate documentation following the Diataxis framework

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/a5c-ai/babysitter/blob/HEAD/library/specializations/sdk-platform-development/skills/diataxis-doc-generator/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/diataxis-doc-generator, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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

skill:
  name: diataxis-doc-generator
  context:
    apiSpec: ./openapi.yaml
    platform: docusaurus
    languages:
      - javascript
      - python
      - curl
    includePlayground: true
    versioning: true

Best Practices

Separate learning-oriented from task-oriented content
Keep tutorials focused on learning, not completeness
Make how-to guides goal-oriented
Ensure reference is accurate and complete
Write explanations to deepen understanding
Include runnable code examples