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。

查看原文