تقديم Harbor وManuscript وSignal: ثلاثة قوالب لثلاثة أنماط من التوثيق
يقدّم Nibleaf ثلاثة قوالب بنيوية لأدلة المنتجات، وقواعد المعرفة الطويلة، ومراجع API كثيفة الشيفرة، مع دعم كامل للعربية وRTL.
· 7 دقائق قراءة · بقلم فريق Nibleaf
ليست كل الوثائق مشكلة بصرية واحدة. قد تُكتب أدلة المنتجات والسياسات ومراجع API كلها بصيغة Markdown، لكن القارئ يتحرك داخل كل نوع بطريقة مختلفة. تغيير اللون المميز مع إبقاء الهيكل نفسه لا يحل هذا الفرق.
يوفر Nibleaf ثلاثة قوالب توثيق تملك بنى صفحات مستقلة: Harbor وManuscript وSignal. تشترك القوالب في رموز التصميم الميسّرة وعارض Markdown والبحث والترجمة ومسار النشر. الذي يتغير هو موضع التنقل، وإطار القراءة، ومكان فهرس الصفحة، وكثافة الواجهة.
Harbor: تنقل ثابت لأدلة المنتجات والمراجع
Harbor هو التخطيط المألوف للتوثيق بعد تنقيحه بعناية. يثبت شجرة المكتبة في أحد الجانبين، ويحافظ على عمود مقالة متوازن في الوسط، ويعرض فهرس الصفحة بجانب المقالة على الشاشات الواسعة.
اختر Harbor عندما ينتقل القراء كثيراً بين الأدلة والصفحات المرجعية. يبقي بنية المعلومات ظاهرة من دون أن يضغط النص، لذلك يصلح افتراضياً لتوثيق منتج يحتوي على أقسام متعددة.
يتضمن Harbor:
- موضعاً ثابتاً للرأس والبحث؛
- تنقلاً دائماً بين أقسام المكتبة؛
- عرضاً متوازناً للقراءة؛
- فهرساً مستقلاً للصفحة على الشاشات الكبيرة؛ و
- درج تنقل مضغوطاً للهاتف يستخدم شجرة الصفحات نفسها.
Manuscript: قراءة تحريرية تقودها الفصول
يعامل Manuscript التوثيق كدليل أو كتاب. يتحول التنقل العام إلى شريط فصول أفقي، وتظهر المقالة على سطح قراءة هادئ منفصل عن خلفية التطبيق. ينتقل فهرس الصفحة إلى هامش القراءة بدلاً من منافسة النص داخل شريط جانبي دائم.
يناسب هذا الهيكل أدلة الإعداد، والكتيبات الداخلية، ومراكز التعلم، ومكتبات السياسات، وقواعد المعرفة الطويلة. يستطيع القارئ التركيز على الفصل الحالي مع بقاء المنشور الأوسع على بعد خطوة واحدة.
يتضمن Manuscript:
- ترويسة تحريرية بدلاً من رأس كثيف بالأدوات؛
- تنقل الفصول فوق سطح القراءة؛
- عمود مقالة أهدأ وأضيق؛
- فهرس صفحة بأسلوب الهامش؛ و
- إيقاعاً عمودياً أكثر راحة للنص الطويل.
Signal: مساحة عمل تقنية تضع الشيفرة أولاً
صُمم Signal للمحتوى التقني الكثيف. يضع المكتبة داخل شريط أوامر عالي التباين، ويمنح المساحة الرئيسية عرضاً أكبر للتواقيع وجداول المعاملات وأمثلة الشيفرة واستجابات API. يصبح فهرس الصفحة شريطاً مضغوطاً فوق المقالة.
اختر Signal لمراجع API وتوثيق SDK وكتيبات تشغيل البنية التحتية وبوابات المطورين التي تتقدم فيها سرعة المسح على القراءة المتتابعة.
يتضمن Signal:
- رأس مساحة عمل مضغوطاً؛
- شريط تنقل شبيهاً بالأوامر؛
- مساحة محتوى واسعة؛
- فهرس أقسام داخل المساحة؛ و
- أسطح شيفرة واضحة وعالية التباين.
افصل البنية عن المظهر
لكل قالب بنية مقصودة، لكن يستطيع الفريق تعديل الألوان الدلالية والخطوط والكثافة والزوايا وكتل الشيفرة والتنبيهات والبطاقات والتبويبات والجداول. هذا الفصل مهم: لا ينبغي لتعديل الهوية أن يعيد تنظيم الموقع خفية، ولا ينبغي لتغيير التخطيط أن يعيد كتابة المحتوى.
تعرض معاينة السمة البنية الحقيقية لكل قالب، لا ثلاث عينات ألوان. ويمكن تبديلها بين LTR وRTL لفحص التنقل والنص المختلط والشيفرة قبل النشر.
تبديل آمن وتصدير قابل للفحص
تعمل القوالب على مصدر Markdown وMDX نفسه. يستطيع الفريق تجربة تخطيط آخر في المسودة ومقارنته في المعاينة، ولا يرى القراء التغيير حتى ينجح نشر جديد. يبقى آخر قالب منشور هو القالب المقدم للقراء أثناء العمل على المسودة.
تصدير السمة بصيغة JSON محدود ومتحقق منه بالمخطط، ولا يسمح بإدخال CSS أو JavaScript تنفيذي. وتتيح قوالب Git-native المستقلة تحرير المكوّنات والتخطيطات والأنماط والأصول في مستودع عادي، مع فصل ملفات المنصة عن الملفات التي يملكها العميل.
إذا كنت تقارن بين البنى الثلاث، تابع إلى دليل اختيار قالب التوثيق.
أسئلة شائعة
- هل قوالب Nibleaf مجرد ألوان مختلفة؟
- لا. يملك كل قالب موضع الرأس والتنقل وإطار المحتوى وفهرس الصفحة وسلوك المعاينة، بينما تبقى الألوان ومعالجات المكوّنات قابلة للتخصيص داخل تلك البنية.
- هل يمكن تبديل القالب من دون إعادة كتابة الصفحات؟
- نعم. تعرض القوالب محتوى Markdown وMDX المحمول نفسه. يغيّر التبديل بنية القارئ ورموز التصميم، ولا يغيّر مصدر الصفحة المخزن.
- هل تدعم القوالب الثلاثة العربية وRTL؟
- نعم. تستخدم القوالب خصائص تخطيط منطقية، وتعكس التنقل الاتجاهي في RTL، وتبقي الشيفرة والأوامر من اليسار إلى اليمين.