إنشاء المستندات وتحريرها

إنشاء المستندات وتحريرها

إنشاء المستندات وتحريرها

المستندات في AB Projects هي صفحات Markdown مع سجل إصدارات كامل. يحدث الإنشاء والتحرير في لوحة جانبية مع معاينة مباشرة، ويُسجَّل كل تغيير حتى يعرف الفريق دائمًا ما تغيّر ولماذا.

إنشاء صفحة

  • في منطقة المستندات الخاصة بالمشروع، ابدأ صفحة جديدة. امنحها عنوانًا، ومسار أصل اختياريًا (الافتراضي / — عيّن شيئًا مثل onboarding لتداخلها)، ووسومًا اختيارية.
  • اكتب المتن بصيغة Markdown. يعرض المحرّر معاينة مباشرة بجانب المصدر بحيث ترى النتيجة المعروضة أثناء الكتابة.
  • احفظ لنشر الصفحة في الشجرة. تصبح الإصدار 1.

تحرير صفحة

  • افتح صفحة واختر تحرير (من قائمة إجراءات الصفحة). تُفتَح اللوحة نفسها مع Markdown الحالي.
  • ملاحظة التعديل مطلوبة عند التحرير. قبل حفظ تغيير يجب أن تُدخل ملاحظة قصيرة تصف ما تغيّر — إذا تركتها فارغة، يطلب منك AB Projects إضافة واحدة «حتى يعرف فريقك ما تغيّر.» (الصفحات الجديدة لا تحتاج إلى ملاحظة؛ التعديلات تحتاج إليها.)
  • يُنشئ الحفظ إصدارًا جديدًا بدلًا من الكتابة فوق القديم — يُحفَظ الإصدار السابق.

سجل الإصدارات والاستعادة

  • تتعقّب كل صفحة رقم إصدار وآخر محرِّر ووقت.
  • افتح السجل من قائمة إجراءات الصفحة لرؤية الإصدارات السابقة، كلٌّ بملاحظة تعديله — بحيث يكون «سبب» كل تغيير مُسجَّلًا.
  • يمكنك استعادة إصدار سابق من قائمة السجل. تُعيد الاستعادة ذلك المحتوى كالصفحة الحالية (وتُسجَّل هي نفسها كإصدار جديد).

حذف صفحة

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

نصائح

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

مع Markdown والمعاينة المباشرة وملاحظات التعديل الإلزامية والسجل الكامل مع الاستعادة، تبقى المستندات سهلة الكتابة وآمنة التغيير.

تم النشر في 1447-11-30
آخر تحديث في 1447-12-02
الإصدار 1