GitBook عبارة عن نظام أساسي يُتيح لك إنشاء مواقع توثيق ومراجع أو مواقع الويكي الخاصة بالشركة. يُمكنك استخدامه لتوثيق جميع أنواع الأشياء ، من التعليمات البرمجية إلى واجهات برمجة التطبيقات وكيفية استخدام منتج التطبيق.
يستخدم GitBook عملية مُماثلة لمستودعات GitHub. تعمل النسخة الرئيسية من الوثائق كنسخة “رئيسية”. يُمكنك بعد ذلك إنشاء “مسودات” تشبه “الفروع”. تحقق من أفضل تطبيقات قاعدة المعرفة لمؤسستك.
تسمح هذه العملية للعديد من المُستخدمين بالعمل في موقع توثيق واحد أثناء معالجة أو منع التعارضات. كما يسمح للتغييرات من الفروع المختلفة بالمرور بعملية مراجعة قبل دمجها.
روابط سريعة
كيف تبدأ في استخدام GitBook
موقع الويكي هو موقع إلكتروني مُصمم لمجموعات من الأشخاص للحصول على أفكار ومشاركتها بسرعة من خلال إنشاء صفحات بسيطة وربطها معاً. يُمكن لشركتك استخدام الويكي لمجموعة متنوعة من الأسباب. على نطاق واسع ، يُمكنك مشاركة كميات كبيرة من المعلومات في قاعدة المعرفة الخاصة بالمؤسسة. على نطاق أصغر ، يُمكنك استخدام فريق لموقع ويكي لجمع الأفكار ومشاركتها بسرعة حول مشروع.
يُمكنك الاختيار من بين العديد من خطط تسعير GitBook. سيعتمد التسعير على ما إذا كنت تستخدم GitBook لمشاريع مفتوحة المصدر أو للاستخدام الشخصي أو تعاون فريق خاص. GitBook مجاني للاستخدام إذا كنت تستخدمه لمشاريع مفتوحة المصدر.
يدعم GitBook لغة Markdown ، وهي لغة ترميز شائعة لها العديد من الفوائد للكتابة أو التوثيق على الويب.
يتكامل GitBook أيضًا مع GitHub ، وهو نظام أساسي لاستضافة التعليمات البرمجية وتخزينها وتحريرها. يُمكنك ربط حساب GitBook مباشرةً بحسابك على GitHub عن طريق تسجيل الدخول باستخدام بيانات اعتماد GitHub.
- ابدأ بالاشتراك في GitBook. إذا كان لديك حساب على GitHub ، فيُمكنك النقر فوق التسجيل باستخدام GitHub.
- بمجرد تسجيل الدخول ، سيعيد GitBook توجيهك إلى ويكي داخلي جديد. سيقوم أيضًا بتعبئة الويكي مسبقًا ببعض المحتوى النموذجي.
نظرة عامة على واجهة GitBook
يحتوي GitBook على العديد من الوظائف التي تُتيح لك إنشاء موقع التوثيق الخاص بك وإجراء تغييرات عليه.
- تتيح لك اللوحة العلوية إنشاء مسودات جديدة أو عرض سجل التغييرات أو عرض أي مناقشات أو مرفقات أخرى.
- يسمح لك الشريط الجانبي الموجود في أقصى اليسار بإنشاء مساحات مُتعددة. يمكنك استخدام المساحات المُنفصلة لمشاريع مختلفة بحيث يمكنك فصل وتنظيم مناطق التوثيق الخاصة بك. يمكنك توسيع الشريط الجانبي أو إغلاقه.
- تعمل اللوحة اليسرى كقائمة لموقع التوثيق. يمكنك عرض الصفحات داخل موقع التوثيق الخاص بك ، واستخدامها لإنشاء مجموعات وصفحات متداخلة. يمكنك أيضًا التنقل عبر الموقع باستخدام الروابط المتوفرة.
- تتضمن اللوحة السفلية أزرارًا حيوية لعملية التحكم في الإصدار. يُمكنك إضافة اسم لمسودتك أو دمج تغيير أو إرسال التغيير للمراجعة.
كيفية إنشاء مسودة جديدة
يُمكنك إنشاء مسودة جديدة عن طريق إنشاء طلب تغيير جديد وإجراء التغييرات بداخله.
- في اللوحة العلوية ، انقر فوق تغيير الطلبات.
- في اللوحة الجديدة التي تظهر على الجانب الأيمن ، انقر فوق علامة التبويب المسودة. سيُظهر لك هذا كل مسوداتك النشطة.
- من هنا ، يُمكنك النقر فوق مسودة موجودة لفتحها. لإنشاء مسودة جديدة ، انقر فوق طلب تغيير جديد ، وانتظر حتى تنتهي الصفحة من التحميل.
- في اللوحة السفلية ، انقر فوق إدخال موضوع. سيؤدي هذا إلى فتح نافذة أين يُمكنك تسمية المسودة الجديدة. على سبيل المثال ، صفحة جديدة — كيفية إعداد Codebase.
كيفية إنشاء الصفحات والمجموعات
بمجرد أن يكون لديك مسودة ، يُمكنك البدء في إجراء تغييرات على الوثائق. يُخزِن GitBook تغييراتك داخل المسودة ، حتى لا تؤثر على النسخة الرئيسية. يمكنك استخدام الشريط الجانبي الأيسر لإضافة صفحات ومجموعات صفحات.
- قم بإنشاء صفحة جديدة من خلال النقر على رابط صفحة جديدة أسفل الشريط الجانبي ، واختيار صفحة مستند جديد من القائمة المنسدلة. بدلاً من ذلك ، يُمكنك التمرير أسفل صفحة موجودة والنقر على زر علامة الجمع الأزرق.
- لإنشاء مجموعة صفحات جديدة ، انقر فوق صفحة جديدة ، وحدد خيار مجموعة جديدة من القائمة المنسدلة.
- يُمكنك إعادة تسمية الصفحة من خلال النقر على زر المزيد (النقاط الثلاث) بجوار الصفحة أو المجموعة واختيار إعادة تسمية.
- ابدأ في إضافة محتوى لملء صفحتك الجديدة. يُمكنك إضافة محتوى بسيط مثل نص أو عناوين. يُتيح لك GitBook أيضًا إضافة كتل محتوى أخرى مثل الصور أو مرفقات الملفات أو الجداول أو علامات التبويب أو مقتطفات التعليمات البرمجية. هناك أيضًا خيار لإضافة عمليات تكامل أخرى مثل تضمين YouTube أو محتوى مُحرِّر مستندات Google.
- انقر فوق الزر Diff view في اللوحة السفلية لعرض الاختلافات بين المسودة ونسخة التوثيق الرئيسية الأصلية.
- بمجرد الانتهاء من كتابة المحتوى الخاص بك ، يُمكنك النقر فوق دمج أو إرسال ودمج أو إرسال للمراجعة.
كيفية إنشاء ارتباط إلى موقع الويكي
يُمكنك الوصول إلى رابط المشاركة من اللوحة العلوية في GitBook. ستحتاج إلى الخروج من المسودة وعرض نسخة التوثيق الرئيسية لتتمكن من عرض الارتباط.
- بشكل افتراضي ، يكون ظهور موقع التوثيق الخاص بك “غير مدرج”. هذا يعني أنه يمكنك الوصول إلى موقع التوثيق باستخدام رابط خاص ، وليس عبر محركات البحث. في اللوحة العلوية ، انقر فوق الزر “غير مدرج”.
- حدد إعدادات الرؤية المطلوبة من القائمة المنسدلة. لاحظ أنَّ GitBook قد يقفل إعدادات رؤية معينة ، وقد تحتاج إلى الترقية للوصول إليها.
- أسفل قائمة إعدادات الرؤية ، يوجد ارتباط يُمكنك مشاركته مع المستخدمين الآخرين الذين سيستخدمون موقع الويكي الخاص بك. انسخ هذا الرابط لمشاركته مع الآخرين.
- أسفل الرابط ، انقر فوق الارتباط وإعدادات النطاق. هذا هو المكان الذي يُمكنك فيه ربط اسم نطاق مُخصص أو تعديل جزء من عنوان URL. إذا كنت تستخدم نطاقًا مُخصصًا ، فيُمكنك عرض وثائق Gitbook حول كيفية تكوين DNS الخاص بك بشكل صحيح.
إنشاء موقع الويكي باستخدام GitBook
يُتيح لك GitBook إمكانية إنشاء مواقع التوثيق أو مواقع الويكي الخاصة بالشركة والعمل عليها بشكل تعاوني. يستعير GitBook المفاهيم من GitHub مثل الفروع ودمجها للتحكم في نسخة رئيسية وإدارة أي تعارضات.
يُمكنك إنشاء مسودة جديدة لإضافة التغييرات الفردية الخاصة بك إلى الوثائق. ضمن المسودة ، يُمكنك إجراء تغييرات على المحتوى ، بالإضافة إلى إضافة صفحات أو مجموعات صفحات جديدة. بمجرد الانتهاء من إجراء التغييرات ، يُمكنك إما دمجها أو إرسالها للمراجعة.
إذا كنت تقوم بإنشاء وثائق داخلية لكود Java الخاص بك ، فقد ترغب في استكشاف Javadoc. يسمح لك Javadoc بتوثيق كود Java الخاص بك تلقائيًا. يُمكنك الإطلاع الآن على كيفية انشاء موقع الويكي الخاص بك.
