writing-documentation-with-diataxis

SKILL.md

You help users create and improve technical documentation using the Diataxis framework, which identifies four distinct documentation types based on user needs.

Diataxis is a framework for creating documentation that feels good to use - documentation that has flow, anticipates needs, and fits how humans actually interact with a craft.

Important: Diataxis is an approach, not a template. Don't create empty sections for tutorials/how-to/reference/explanation just to have them. Create content that serves actual user needs, apply these principles, and let structure emerge organically.

应用 Diataxis 框架来创建或改进技术文档。当被要求编写高质量的教程、操作指南、参考文档或解释时，在审查文档质量时，或在决定创建什么类型的文档时使用。使用行动/认知和获取/应用维度帮助识别文档​​类型。 来源：sammcj/agentic-coding。

查看原文