Diátaxis: نهج منهجي لكتابة التوثيق التقني

Diátaxis نهج منهجي لكتابة التوثيق التقني. يعرضه مؤلفه دانييلي بروتشيدا طريقةً للتفكير في التوثيق وممارسته: فهو يحدد مقاربات للمحتوى والبنية والشكل تنبع من دراسة احتياجات مستخدمي التوثيق.

أربعة أنواع من التوثيق

الفكرة الأساسية أن هناك أربعة أنواع جوهرية مختلفة من التوثيق تستجيب لأربع احتياجات مختلفة: الدروس التعليمية (tutorials)، والأدلة الإجرائية (how-to guides)، والمراجع (reference)، والشرح (explanation). لكل نوع غايته الخاصة وطريقة كتابة مختلفة. الدرس التعليمي درسٌ يأخذ المتعلّم من يده عبر تجربة تعلّم، وهو عملي دائماً، مثل درس قيادة السيارة. أما الدليل الإجرائي فيخاطب مستخدماً متمكّناً بالفعل ويساعده على تحقيق هدف واقعي أو حل مشكلة؛ إنه معنيّ بالعمل لا بالدراسة. تحتوي المراجع على الحقائق التقنية اللازمة للعمل بشكل صحيح: دقيقة وكاملة وخالية من التأويل، مثل خريطة بحرية. ويقدّم الشرح السياق والخلفية، ويربط العناصر ببعضها ويجيب عن سؤال «لماذا».

خريطة وبوصلة

يرتّب Diátaxis هذه الأنواع الأربعة على خريطة مفاهيمية، ويضيف بوصلة تساعد في تحديد المكان الذي ينتمي إليه كل محتوى. تتعلق الدروس والأدلة الإجرائية بما يفعله المستخدم، أي الفعل، بينما تتعلق المراجع والشرح بما يعرفه المستخدم، أي الإدراك. وتخدم الدروس والشرح اكتساب المهارة، أي الدراسة، بينما تخدم الأدلة الإجرائية والمراجع تطبيق المهارة، أي العمل. وبحسب المشروع، فإن تجاوز هذه الحدود أو طمسها يقف في قلب عدد هائل من مشكلات التوثيق.

مجرَّب عملياً

يُقدَّم النهج بوصفه خفيفاً وسهل الاستيعاب ولا يفرض قيوداً تقنية، وقد طُبّقت مبادئه بنجاح في مئات مشاريع التوثيق. يقول غريغ فريلو من Vonage إن Diátaxis مكّن من بناء توثيق داخلي عالي الجودة؛ وتذكر ميغان سوليفان أن مشروع Gatsby اعتمد على هذا الإطار عند إعادة تنظيم توثيقه مفتوح المصدر، وأن المربعات الأربعة ساعدت في ترتيب أولويات أنواع الوثائق؛ ويشير آدم شفارتز إلى أنه أثناء إعادة تصميم توثيق مطوّري Cloudflare أصبح Diátaxis «نجمنا القطبي في هندسة المعلومات».

كيف تبدأ

نصيحة الموقع نفسه: ابدأ بالتطبيق، على أي شيء ولو كان صغيراً. دورة العمل المقترحة هي: انظر إلى التوثيق الذي أمامك الآن، واسأل إن كان هناك أي سبيل لتحسينه، واختر شيئاً واحداً يمكنك فعله فوراً، ثم افعله؛ وكرّر بعد ذلك. لا يُشترط الإيمان بالنظرية؛ إذ يقدّمها المؤلف نهجاً عملياً محضاً، تقوم قيمته على مساعدة الناس في إنشاء توثيق أفضل.