أفضل 6 أدوات للتوثيق: قائمة منسقة لعام 2022

هل تبحث عن أفضل أدوات التوثيق لمساعدتك في إنشاء محتوى توثيق داخلي أو خارجي من الدرجة الأولى؟

سواء كنت تقوم بإنشاء وثائق عامة للمستهلكين غير التقنيين أو المحتوى التقني مثل وثائق API الخاصة بالبرنامج (أو أي شيء بينهما) ، فهناك بعض أدوات التوثيق الرائعة لمساعدتك في إدارة المحتوى الخاص بك ونشره للمستخدمين.

في هذا المنشور ، قمنا برعاية قائمة من أفضل ستة خيارات ، بما في ذلك الحلول مفتوحة المصدر و SaaS لجميع الميزانيات (بما في ذلك المجانية).

بالنسبة لجميع الأدوات الستة ، سنسلط الضوء على مزاياها ، وعيوبها ، وأسعارها ، وكيف يمكنك البدء في توثيقك باستخدام هذه الأداة.

دعنا نقفز مباشرة!

ستة من أفضل أدوات التوثيق

1. قاعدة المعرفة البطولية
2. GitBook
3. وثيقة 360
4. اقرأ المستندات
5. فكرة + محرك
6. Helpjuice

1. قاعدة المعارف البطولية

Heroic Knowledge Base هي أداة توثيق مفتوحة المصدر تعتمد على برنامج WordPress الشهير ، وهو أيضًا مفتوح المصدر.

يمكنك تثبيت Heroic Knowledge Base كمكوِّن إضافي على WordPress لتحويل موقع WordPress الخاص بك على الفور إلى مركز توثيق.

إن كيفية إنشاء موقعك أمر متروك لك - يمكنك إنشاء موقع WordPress جديد تمامًا مخصص حصريًا للتوثيق أو يمكنك تثبيت Heroic Knowledge Base على موقع WordPress موجود لإضافة وظيفة التوثيق إلى هذا الموقع.

لإنشاء محتوى ، يمكنك استخدام محرر قوالب WordPress المرن ، جنبًا إلى جنب مع نظام المراجعة المدمج في WordPress للتحكم في الإصدار.

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

يمكنك أيضًا الحصول على أدوات لجعل بعض أو كل وثائقك خاصة ، اعتمادًا على ما إذا كنت تقوم بإنشاء وثائق عامة أو داخلية.

تمنحك قاعدة المعارف البطولية أيضًا الكثير من الميزات لإنشاء تجربة رائعة للزائرين وتحسين التوثيق الخاص بك:

• بحث AJAX في الوقت الحقيقي مع اقتراحات حية.
• فئات وعلامات لتنظيم المقالات.
• تحليلات مدمجة لتتبع عمليات البحث والمشاهدات وفعالية المقالة والتحويلات إلى قنوات الدعم المباشر.

نظرًا لأنه يعتمد على WordPress ، يمكنك أيضًا توسيع وثائقك باستخدام مكونات إضافية أخرى. على سبيل المثال ، يمكنك استخدام المكون الإضافي المجاني Multicollab لإضافة التعليقات على غرار محرر مستندات Google والتعاون إلى محرر المحتوى.

فوائد

• عدد غير محدود من المستخدمين والمقالات والفئات وما إلى ذلك . في الأساس ، لا توجد حدود تعسفية مثل التي تواجهها عادةً في أدوات توثيق SaaS.
• مرنة . تتضمن قاعدة المعارف البطولية الكثير من الميزات المضمنة لمساعدتك في تكوين وثائقك ويمكنك أيضًا تثبيت مكونات WordPress الإضافية الأخرى حسب الحاجة ، مثل إضافة ميزات التعاون.
• ملكية البيانات الكاملة . تبقى جميع بياناتك 100٪ على خوادمك الخاصة في جميع الأوقات.
• المصدر المفتوح . كل من WordPress و Heroic Knowledge Base مفتوحان المصدر.

سلبيات

• إذا كنت لا ترغب في استخدام WordPress لسبب ما ، فمن المهم ملاحظة أن Heroic Knowledge Base تعمل فقط مع WordPress.

التسعير

يبدأ Heroic Knowledge Base بسعر 149 دولارًا للاستخدام على موقع ويب واحد وسنة واحدة من الدعم والتحديثات. ستحتفظ بإمكانية الوصول إلى البرنامج إلى الأبد دون أي تكلفة إضافية ، ولكنك ستحتاج إلى تجديد ترخيصك لمواصلة تلقي الدعم والتحديثات بعد السنة الأولى.

ستحتاج أيضًا إلى موقع ويب WordPress ، والذي قد يكلف بعض المال إذا لم يكن لديك بالفعل وصول إلى استضافة مواقع الويب القادرة على تشغيل WordPress.

كيف تبدأ

فيما يلي كيفية إعداد مركز توثيق باستخدام Heroic Knowledge Base:

1. قم بإنشاء موقع WordPress ليكون بمثابة قاعدة المحور الخاص بك (إذا لم تكن قد قمت بذلك بالفعل).
2. شراء وتثبيت البرنامج المساعد Heroic Knowledge Base.
3. قم بتكوين سلوك مركز التوثيق الخاص بك باستخدام الإعدادات ( Heroic KB → Settings )
4. أضف المقالات باستخدام محرر الكتل المرنة.

يمكنك أيضًا إضافة تعديلات أخرى ، مثل إنشاء موقع إنترانت ، أو تقييد الوصول إلى المستخدمين المسجلين ، أو طلب كلمة مرور لعرض الوثائق (والتي يمكن أن تكون مفيدة للوثائق الداخلية).

2. GitBook

كما يوحي الاسم ، فإن GitBook هي أداة توثيق موجهة أكثر نحو فرق البرامج التي تحتاج إلى إنشاء وثائق عامة أو خاصة.

على سبيل المثال ، يمكنك مزامنة GitBook مع مستودع GitHub أو GitLab الذي يحتوي على ملفات markdown لإنشاء وثائقك بهذه الطريقة. ومع ذلك ، لست مجبرًا على استخدام Git فقط لاستخدام GitBook ويمكنك أيضًا إنشاء محتوى باستخدام محرر بديهي أو استيراده من مصادر أخرى مثل ملفات markdown ومستندات Word والمزيد.

لتنظيم وثائقك ، يمكنك استخدام "المسافات" (أي قاعدة معرفية فريدة واحدة) و "مجموعات" (أي فئة واحدة داخل قاعدة المعرفة).

تتضمن بعض الميزات البارزة الأخرى ما يلي:

• التحكم في الإصدار.
• تحرير الفريق المباشر والتعاون.
• تضمينات غنية في محرر المحتوى.
• تصدير سهل لملفات PDF.

فوائد

• استخدم سير العمل الفني المألوف . بالنسبة للفرق الفنية ، يتيح لك GitBook استخدام الأدوات التي تعرفها بالفعل (مثل Git). كما تستخدم المصطلحات الفنية ، مثل "الفروع" و "طلبات التغيير" لإجراء عمليات التحرير.
• ميزات التعاون . يمكن أن يكون هذا مفيدًا إذا كان لديك عدة أشخاص يعملون على نفس المستند (ربما حتى في نفس الوقت).
• مجاني للمؤسسات غير الربحية. إذا كنت مؤسسة غير ربحية أو تدير مشروعًا مفتوح المصدر ، فيمكنك استخدام GitBook مجانًا.

سلبيات

• تقني . إذا لم تكن تقوم بإنشاء وثائق البرنامج ، فقد يبدو GitBook معقدًا بعض الشيء. من المحتمل أن يرغب الأشخاص الذين يتطلعون إلى إنشاء وثائق غير فنية في البحث في مكان آخر.

التسعير

GitBook مجاني للاستخدام الفردي والمشاريع غير الربحية والمفتوحة المصدر. تبدأ الخطط التجارية من 8 دولارات لكل مستخدم شهريًا ، بحد أدنى 5 مستخدمين. لذا فإن أرخص خطة ستكون 40 دولارًا في الشهر.

كيف تبدأ مع قاعدة المعرفة البطولية

للبدء ، تحتاج فقط إلى التسجيل للحصول على حساب GitBook والبدء في البناء. يمكنك إما المزامنة مع مستودع على GitHub أو البناء من البداية باستخدام محرري محتوى GitBook.

3. Document360

Document360 هي أداة توثيق SaaS تتيح لك إنشاء قاعدة معارفك الداخلية أو الأمامية.

نظرًا لنهج SaaS الخاص به ، من السهل جدًا البدء به. ما عليك سوى التسجيل للحصول على حساب والبدء في إنشاء وثائقك عبر واجهة سهلة الاستخدام.

يمكنك إنشاء محتوى باستخدام محرر WYSIWYG بسيط مع دعم Markdown. ستتمكن أيضًا من الوصول إلى أدوات التعاون والتحكم في الإصدار ، وهو أمر مفيد إذا كنت تعمل مع فريق.

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

فوائد

• إعداد سهل . لإنشاء الوثائق ، ما عليك سوى التسجيل للحصول على حساب والبدء في الكتابة.
• استضافت من أجلك . يتولى Document360 استضافة المستندات الخاصة بك وصيانتها نيابةً عنك ، لذلك لن تحتاج أبدًا إلى العبث بالتحديثات أو أي شيء.
• ميزات الإنتاجية . يمكنك الوصول إلى بعض الميزات الرائعة مثل تذكيرات المراجعة التلقائية وإشعارات أحداث قاعدة المعرفة والمزيد.

سلبيات

• مكلفة. أرخص خطة مدفوعة هي بالفعل 119 دولارًا شهريًا وهذا يتضمن ميزات محدودة فقط.
• القيود . إذا كنت بحاجة إلى المزيد من حسابات الفريق أو قواعد المعرفة ، فستحتاج إلى دفع المزيد. على سبيل المثال ، تتضمن خطة بدء التشغيل خمسة حسابات فريق فقط. إذا كنت تريد أكثر من ذلك ، فستدفع 19 دولارًا شهريًا لكل حساب.

التسعير

Document360 هي أداة SaaS ، لذا ستدفع رسومًا شهرية أو سنوية طالما أنك تريد استخدامها. تبدأ الخطط بسعر 119 دولارًا لكل مشروع شهريًا ، بالإضافة إلى 39 دولارًا لكل إصدار قاعدة معارف إضافية و 19 دولارًا لكل حساب فريق بخلاف الحسابات الخمسة المضمنة.

هناك أيضًا خطة مجانية تتيح لك إنشاء ما يصل إلى 50 مقالة بسعة تخزين تبلغ 1 غيغابايت والوصول المحدود إلى الميزات.

كيف تبدأ مع Document360

Document360 هي أداة توثيق SaaS ، مما يعني أن كل ما عليك فعله هو التسجيل للحصول على حساب للبدء.

هناك نسخة تجريبية مجانية مدتها 14 يومًا حتى تتمكن من استكشاف جميع الميزات مجانًا.

4. اقرأ المستندات

قراءة المستندات هي أداة توثيق مصممة خصيصًا للبرامج أو الوثائق الفنية.

يتيح لك إدارة المحتوى والإصدارات باستخدام Git ثم النشر بسهولة إلى واجهة أمامية سهلة الاستخدام. يعني هذا النهج أنه لا يمكن الوصول إليه إلا للمطورين ... ولكن هذا منطقي نظرًا لأنه يركز على إنشاء التوثيق الفني.

بناءً على الإصدار الذي تستخدمه ، يمكنك أيضًا الوصول إلى بعض أو كل الميزات التالية:

• التحليلات لمعرفة ما يبحث عنه الزوار وما يقرؤونه.
• نتائج البحث والاقتراحات الحية.
• بنى متزامنة متعددة. على سبيل المثال ، تصميم واحد للإنتاج وآخر للنسخة التجريبية أو آخر للإصدار 1.0 وآخر للإصدار 2.0.
• تصدير سهل إلى PDF أو HTML أو epub.
• تسجيل الدخول الأحادي عبر Google Workspace أو موفر VCS (GitHub أو GitLab أو Bitbucket).

فوائد

• استخدم أدوات التطوير . باستخدام أدوات مثل Git لإدارة الوثائق ، يحاول Read the Docs بناء نفسه في مهام سير العمل الحالية لمطوري البرامج.
• إصدار قوي . يجعل Git من السهل إدارة الإصدار ويمكنك أيضًا نشر إصدارات متعددة من مستنداتك في نفس الوقت ، وهو أمر رائع إذا كان الأشخاص يستخدمون إصدارات مختلفة من برنامجك.

سلبيات

• إعداد أكثر تعقيدًا . يعد إعداد "قراءة المستندات" أكثر تعقيدًا من أدوات التوثيق الأخرى لأنك تحتاج إلى العمل عبر Git. ومع ذلك ، نظرًا لأنه يركز على التوثيق الفني ، يجب ألا تواجه أنواع الأشخاص الذين يستخدمون قراءة المستندات أي مشاكل.
• فقط للوثائق الفنية . إذا لم تكن تقوم بإنشاء برامج / وثائق فنية ، فستحتاج إلى اختيار أداة توثيق مختلفة لأن قراءة المستندات ليست مناسبة لك.

التسعير

إذا كان لديك مشروع مفتوح المصدر ، فإن قراءة المستندات تتيح لك إنشاء واستضافة وثائقك مجانًا. في الواقع ، تقول Read the Docs إنها تستضيف وثائق مجانية لأكثر من 240.000 مشروع مفتوح المصدر.

بالنسبة للشركات التجارية ، هناك أيضًا خدمة مدفوعة Read the Docs for Business ، والتي تبدأ من 50 دولارًا في الشهر. تتضمن جميع الخطط عددًا غير محدود من المشاريع والمستخدمين - القيود الرئيسية هي الميزات التي تحصل عليها وعدد الإنشاءات المتزامنة التي يمكنك الحصول عليها.

كيف تبدأ مع قراءة المستندات

تمنحك قراءة المستندات طريقتين لكتابة وثائقك الفعلية:

1. مكدوكس
2. أبو الهول

بمجرد استخدام هذه الأدوات لإنشاء مستودع Git يحتوي على محتوى التوثيق الخاص بك ، ستقوم "قراءة المستندات" تلقائيًا باستيراد المستودع لإنشاء وثائقك.

5. فكرة + Engine.so

Notion عبارة عن كرة منحنية قليلاً هنا من حيث أنها ليست مصممة خصيصًا للتوثيق. ومع ذلك ، مع الإعداد الصحيح ، يمكن أن يكون أداة رائعة للتعامل مع جميع أنواع الوثائق المختلفة.

إذا لم تكن معتادًا على Notion ، فهي في الأساس أداة الكل في واحد للتعامل مع أي نوع من المعرفة والبيانات وإدارة المشاريع وغير ذلك الكثير.

يمكنك استخدامه للعديد من الأشياء المختلفة ، بما في ذلك إنشاء جميع أنواع الوثائق. على الرغم من ذلك ، فإن الجانب السلبي هو أن Notion في حد ذاتها لا تركز حقًا على نشر تلك المعلومات على موقع ويب حيث يمكن للآخرين التفاعل معها.

وهنا يأتي دور Engine.so. باستخدام Engine.so ( خدمة جهة خارجية ) ، يمكنك نشر محتوى Notion على موقع الويب الخاص بك لإنشاء مركز التوثيق الخاص بك بسهولة. يمكنك أن ترى مثالاً لما يبدو عليه ذلك في وثائق Engine.so.

فوائد

• طرق فريدة لتقديم المعلومات . يمنحك استخدام Notion قدرًا كبيرًا من المرونة التي قد لا تحصل عليها باستخدام أدوات التوثيق الأكثر تحديدًا. على سبيل المثال ، يمكنك استخدام العديد من قوالب Notion بطرق شيقة.
• سهل الاستخدام . على عكس الأدوات المستندة إلى Git ، فإن هذا النهج سهل لكل من المستخدمين التقنيين وغير التقنيين.
• بأسعار معقولة . على الرغم من عدم وجود خطة مجانية ، يجب أن يكون هذا الأسلوب ميسور التكلفة لمعظم حالات الاستخدام.

سلبيات

• ليست مصممة لغرض التوثيق . بينما تعمل Notion بشكل رائع للتوثيق ، فإن هذا ليس محور التركيز الوحيد لها كما هو الحال مع أدوات التوثيق الأخرى في هذه القائمة. إذا كنت تخطط للحصول على مئات المقالات ، فقد تفضل أداة مصممة خصيصًا لهذا الغرض.
• تحكم محدود في الإصدار. لا يوفر هذا الأسلوب تحكمًا قويًا في الإصدار. إذا كنت تدفع مقابل Notion ، فيمكنك الحصول على 30 يومًا من تاريخ الإصدار ، لكنها ليست قوية مثل Git أو نظام WordPress الذي تحصل عليه مع Heroic Knowledge Base.

التسعير

لدى Notion خطة مجانية يجب أن تعمل بشكل جيد لحالات الاستخدام الأساسية. ومع ذلك ، هناك احتمال أنك قد ترغب في الدفع حسب احتياجاتك الخاصة.

لتحويل محتوى Notion الخاص بك إلى مركز توثيق عام ، ستحتاج إلى الدفع مقابل Engine.so. تكلف Engine.so 19 دولارًا شهريًا لما يصل إلى 300 صفحة أو 49 دولارًا شهريًا لما يصل إلى 1000 صفحة. يمكنك تجربته مع نسخة تجريبية مجانية مدتها 14 يومًا.

كيف تبدأ مع Notion

فيما يلي كيفية إنشاء الوثائق باستخدام هذا الإعداد:

1. التسجيل للحصول على حساب فكرة.
2. قم بإنشاء وثائقك باستخدام Notion. يمكنك العثور على قوالب فكرة معدة مسبقًا لمحتوى التوثيق ، مثل هذه القوالب من Beestat.
3. سجل للحصول على حساب Engine.so.
4. انشر وثائق Notion الخاصة بك على موقع الويب / مركز التوثيق المخصص الخاص بك باستخدام Engine.so.

6. Helpjuice

على غرار Document360 ، تعد Helpjuice قاعدة معارف وأداة توثيق شائعة أخرى لـ SaaS.

يساعدك في إنشاء أي نوع من الوثائق بسهولة باستخدام محرر نصوص بسيط ، بما في ذلك خيارات الاستيراد من مستندات Word لتوفير الوقت.

يمكنك أيضًا الوصول إلى مجموعة من الميزات لإنشاء وثائق فعالة:

• نتائج البحث الفوري / الاقتراحات.
• تحليلات لتتبع عمليات البحث ومشاهدات الصفحة وغير ذلك الكثير.
• خيار لنشر إصدارات متعددة من وثائقك.
• مستويات وصول المستخدم للتحكم في من يمكنه رؤية المقالات المختلفة.
• ميزات التعاون بما في ذلك التعليقات في المحرر.

فوائد

• إعداد سهل . لإنشاء الوثائق ، ما عليك سوى التسجيل للحصول على حساب.
• استضافت من أجلك . تتولى Helpjuice استضافة المستندات الخاصة بك وصيانتها نيابةً عنك ، لذلك لن تحتاج أبدًا إلى العبث بالتحديثات أو أي شيء.
• لا توجد خطط مقفلة بالميزات . على الرغم من أن Helpjuice ليس لديها خطة مجانية ، إلا أن جميع خططها المدفوعة تتيح لك الوصول إلى جميع الميزات.

سلبيات

• غالي الثمن . تبدأ أرخص خطة بسعر 120 دولارًا شهريًا ويمكن أن تتراوح حتى 500 دولار شهريًا.
• حدود المستخدم . إذا كان لديك فريق كبير ، يمكن أن تصبح Helpjuice باهظة الثمن. على سبيل المثال ، إذا كان لديك أكثر من 60 مستخدمًا ، فستحتاج إلى خطة 500 دولار شهريًا.

التسعير

تبدأ خطط Helpjuice المدفوعة من 120 دولارًا شهريًا لجميع الميزات وما يصل إلى أربعة مستخدمين. ترتفع الخطط من هناك بناءً على عدد المستخدمين الذين تحتاجهم ، وتصل إلى 500 دولار شهريًا للمستخدمين غير المحدودين.

الشيء الفريد هو أنه يمكنك الوصول إلى جميع الميزات الموجودة في جميع الخطط ، بينما يقوم شيء مثل Document360 بإغلاق بعض الميزات خلف الخطط ذات المستوى الأعلى.

يمكنك أيضًا اختبار كل شيء باستخدام نسخة تجريبية مجانية مدتها 14 يومًا.

كيف تبدأ مع Helpjuice

للبدء ، كل ما عليك فعله هو التسجيل للحصول على حساب Helpjuice والبدء في إضافة المحتوى الخاص بك.

ما هي أفضل أداة توثيق لاحتياجاتك؟

في النهاية ، يعتمد اختيار أفضل أداة توثيق حقًا على احتياجاتك الخاصة وميزانيتك ومستوى معرفتك.

فيما يلي بعض الأسئلة الشائعة التي تريد أن تطرحها على نفسك لتضييق نطاق البحث:

• هل تريد حلًا مستضافًا ذاتيًا أم أنك موافق على استخدام أداة SaaS؟
• وبالمثل ، هل تريد حلاً مفتوح المصدر أم أنك موافق على استخدام أداة مغلقة المصدر؟
• هل تقوم بإنشاء وثائق فنية للغاية (مثل وثائق واجهة برمجة التطبيقات) أو المزيد من الوثائق التي تواجه المستهلك؟
• هل تحب فكرة استخدام Git للتحكم في الإصدار / إدارة المحتوى أم تفضل أن يكون لديك نظام إدارة معرفة مخصص؟
• ما هي ميزانيتك؟ هل أنت موافق على دفع رسوم شهرية مستمرة أم تريد شيئًا مجانيًا أو دفعة لمرة واحدة؟

من خلال الإجابة على هذه الأسئلة ، يجب أن تكون لديك فكرة جيدة عن أفضل أداة توثيق لاحتياجاتك.

إذا لم تكن متأكدًا من أين تبدأ ، فنحن نعتقد أن قاعدة المعارف البطولية يمكنها تلبية احتياجات معظم الأعمال. إنه يوفر طريقة فعالة من حيث التكلفة ومفتوحة المصدر تمنحك ملكية كاملة لبياناتك بسعر أقل من معظم الأدوات الأخرى.

ولكن في الوقت نفسه ، لا يزال بإمكانك الوصول إلى العديد من الميزات لإنشاء وثائق من الدرجة الأولى ، مثل اقتراحات البحث المباشر والتحليلات التفصيلية. يمكنك أيضًا الوصول إلى نظام WordPress البيئي بالكامل إذا كنت تريد المزيد من المرونة.

لمعرفة المزيد والبدء ، توجه إلى صفحة منتج قاعدة المعارف البطولية.