writing-documentation-with-diataxis

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.