What is the Diataxis framework?

Diataxis is a systematic approach to technical documentation that categorizes content into four distinct types based on user needs: tutorials, how-to guides, reference material, and explanation.

Does it support Architecture Decision Records (ADRs)?

Yes, the skill includes templates and guidelines for documenting architecture decisions, providing context, alternatives considered, and long-term consequences.

How does this skill improve documentation quality?

By providing structured checklists and specific templates for different audiences, it ensures no critical information is missing and that the content is optimized for the reader's specific goal.

Can this skill help me write a better README?

Yes, it provides specific templates and checklists for both root-level and module-level READMEs to ensure they are actionable, clear, and include all necessary sections.

Documentation Standards & Templates

Name: Documentation Standards & Templates
Author: OshanKHZ

byOshanKHZ

•

学习与文档

Standardizes project documentation using Diataxis principles with ready-to-use templates and quality checklists.

关于

This skill provides a comprehensive framework for creating high-quality software documentation based on the Diataxis system. It offers structured templates and validation checklists for seven essential documentation types, including READMEs, API references, tutorials, and architecture decision records (ADRs). By guiding users through the purpose and audience of each format, it ensures documentation is consistent, user-centric, and technically accurate, making it indispensable for maintainers and developers looking to improve project onboarding and long-term maintainability.

主要功能

Diataxis-based templates for Tutorials, How-tos, Reference, and Explanations
Specific validation checklists for READMEs, API docs, and CONTRIBUTING guides
Structured Architecture Decision Record (ADR) templates for design transparency
Ready-to-use examples for root project and module-level documentation
Decision trees to help select the correct documentation type for any audience
3 GitHub stars

使用场景

Creating comprehensive API documentation with clear request/response examples
Drafting a high-impact root README for a new open-source repository
Converting technical notes into a structured 'How-to' guide for specific tasks

关于

主要功能

Diataxis-based templates for Tutorials, How-tos, Reference, and Explanations
Specific validation checklists for READMEs, API docs, and CONTRIBUTING guides
Structured Architecture Decision Record (ADR) templates for design transparency
Ready-to-use examples for root project and module-level documentation
Decision trees to help select the correct documentation type for any audience
3 GitHub stars

使用场景

Creating comprehensive API documentation with clear request/response examples
Drafting a high-impact root README for a new open-source repository
Converting technical notes into a structured 'How-to' guide for specific tasks