What problem does it solve?
This Skill addresses the common issue of technical documentation being difficult to learn from, poorly structured, or lacking clear examples, leading to developer frustration and slower adoption.
Core Features & Use Cases
- Enforces Diátaxis Framework: Provides guidance on structuring documentation into Tutorials, How-Tos, Explanations, and References.
- Code Example Best Practices: Details how to write minimal, complete, and runnable code examples, including success and error paths.
- Structured Prerequisites: Advocates for tables or checklists over prose for prerequisites.
- Progressive Tutorial Structure: Emphasizes testable states at the end of each tutorial step.
- Troubleshooting Placement: Recommends placing troubleshooting tips at the end of relevant steps.
- Identifies Anti-Patterns: Highlights common mistakes like tutorials requiring production setup or how-tos that teach instead of guide.
- Use Case: A technical writer can use this Skill to audit and improve the quality and effectiveness of API documentation, SDK guides, or product tutorials, ensuring developers can learn and use the product efficiently.
Quick Start
Review the provided documentation for the Diátaxis framework and best practices for code examples.
