أفضل ممارسات ضبط إصدار الوثائق

باختصار

• أبقِ نظام الترقيم مستقراً بمجرد اختياره: إعادة الترقيم تكسر كل إحالة متقاطعة استشهدت بالرقم القديم.
• اطبع الإصدار والتاريخ والمعتمِد في المكان الثابت نفسه على كل صفحة، لا في اسم الملف أو الخصائص فقط.
• لا تدع أبداً شخصين يحرّران الإصدار «الحالي» بالتوازي دون اصطلاح قفل أو تسجيل خروج.
• قرّر مسبقاً، كتابةً، بالضبط ما يجعل التغيير رئيسياً مقابل فرعياً.
• عامل «لا تغييرات مطلوبة» كنتيجة مراجعة مُسجَّلة، لا صمتاً.
• يستبدل QueryChart اصطلاح تسجيل الخروج بمخطط حي معتمَد واحد؛ راجع /features/version-control.

النظام بجودة عامه الثاني فقط

نادراً ما يفشل نظام ترقيم في شهره الأول. يفشل في عامه الثاني، حين يكون الشخص الذي وضع «أرقام صحيحة للنسخ الصادرة» قد غادر، ويبتكر مسؤول ضبط وثائق جديد قاعدة مختلفة قليلاً لمعالجة حالة عاجلة واحدة، ويبدأ اصطلاحان بالعمل داخل السجل نفسه في آن واحد. تفترض هذه الصفحة أن القرار الأساسي مُتَّخذ أصلاً (واختيار نظام في المقام الأول مغطى على /ar/guides/كيفية-ضبط-إصدار-وثيقة) وهي عن الحفنة من العادات التي تُبقي نظاماً مختاراً يعمل بمجرد أن يصطدم بحجم حقيقي، وتبدّل موظفين، وإلحاح.

أربعة أشياء تسوء بعد اختيار النظام، ولا واحد منها يتعلق بالنظام نفسه. إعادة ترقيم مكتبة قائمة لإصلاح عيب مُتصوَّر تكسر كل إحالة متقاطعة وسجل تدريب واستشهاد تدقيق سابق سمّى الأرقام القديمة، فتكلّف عادةً أكثر من العيش مع العيب. رقم إصدار يعيش فقط في اسم ملف أو لوحة خصائص يختفي لحظة أن يطبع أحد صفحة أو يعيد توجيه لقطة شاشة، فيحتاج موقعاً ثابتاً مطبوعاً بدلاً من ذلك. معِدّان يحرّران الملف «الحالي» نفسه في بعد الظهر نفسه ليست مشكلة ترقيم أصلاً، بل اصطلاح قفل أو تسجيل خروج مفقود، ولا يصمد أي نظام بدونه. ومراجعة دورية لا تجد خطأً ما زالت تحتاج أن تترك أثراً، وإلا كانت بعد عام لا تُميَّز عن مراجعة لم تحدث قط. لا شيء من هذا دورة حياة الوثيقة الكاملة (فالطلب حتى الإلغاء مغطى بالكامل على /ar/templates/عملية-ضبط-الوثائق) بل هو طبقة الترقيم داخل تلك الدورة، مُنفَّذة بإتقان لا مجرد مُنفَّذة.

يزيل QueryChart أحد أنماط الفشل هذه هيكلياً بدل سياسياً. يوجد مخطط حي معتمَد واحد لكل وثيقة بدل مجموعة ملفات على أحدهم أن يتذكر قفلها، ويُلتقط كل حفظ تلقائياً كقيد جديد في سجل التغييرات مع الفاعل والحقل الدقيق الذي تغيّر، وتضع مقارنة الإصدارات أي تنقيحين جنباً إلى جنب. لا يستطيع شخصان تفريع النسخة «الحالية» بصمت، لأن لا يوجد سوى واحدة، وتاريخها كاملاً استعلام لا اختبار ذاكرة. راجع /features/version-control.

أين تظهر هذه الممارسات في حياة وثيقة واحدة

المخطط نفسه من 18 صفاً لضبط إصدار الوثائق، مقروءاً لما يجعل نظام ترقيمه يصمد لا لخطوات الترقيم نفسها.

1. النظام يبدأ قبل أن يراجع أحد أي شيء

   «تعيين إصدار المسودة الأولي 0.1» يحدث مباشرةً بعد «صياغة وثيقة جديدة»، قبل «تعميم المسودة للمراجعة الداخلية» أو «المراجع يقيّم المسودة»: يُثبَّت النظام العشري عند الصف الثاني، لا يُبتكَر في منتصف قرار «هل توجد تعديلات مطلوبة؟» الأول.

2. إعادة العمل ترفع، لا تُعيد الترقيم أبداً

   تعود «رفع الإصدار الفرعي» و«تنقيح المسودة وفق الملاحظات» إلى المراجعة على فرع اسمه «إعادة مراجعة» قبل «تقديم المسودة النهائية للاعتماد» و«المعتمِد يراجع المسودة النهائية»: القاعدة العشرية نفسها تصمد عبر كل جولة، فيبقى الاستشهاد بالمسودة 0.3 يسمّي نسخة دقيقة واحدة.

3. قرار واحد يرسم خط الرئيسي مقابل الفرعي

   «هل اعتُمدت للإصدار؟» هو الصف الوحيد بمسار إلى رقم صحيح: فرع الاعتماد يصل إلى «تعيين الإصدار الرئيسي 1.0»، بينما يعود المرفوض إلى «رفع الإصدار الفرعي»؛ ثم تثبّت «تحديث سجل تاريخ الإصدارات» و«نشر الإصدار المعتمد» و«وسم الإصدار السابق بأنه ملغى» ذلك القرار في صف ملف قبل أن يقرأ أحد النسخة الجديدة.

4. وثيقة لا تحتاج تغييراً ما زالت تحصل على علامة

   يُجاب «هل طُلب تغيير بعد النشر؟» حتى حين تكون الإجابة لا: ينتهي ذلك الفرع عند «الإصدار الحالي يبقى سارياً»، نتيجة مُسمّاة لا غياب نشاط، بينما يعيد نعم فتح الوثيقة عند «إعادة فتح الوثيقة عند الإصدار التالي» بدل بدء نسخة ثانية بجانبها.

كيف تعمل

1. جمّد نظام الترقيم بمجرد أن تعتمد عليه وثائق حقيقية

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

2. ضع الإصدار والتاريخ والمعتمِد في مكان ثابت واحد على كل قالب

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

3. امنح الإصدار «الحالي» اصطلاح قفل أو تسجيل خروج

   قرّر من يستطيع فتح الإصدار الحالي للتحرير في آن واحد، وكيف يعرف معِدّ ثانٍ أن أحدهم يفعل ذلك أصلاً: علامة تسجيل خروج في السجل، أو ملف مقفل، أو نسخة حية معتمَدة واحدة فقط حيث يفوز حفظ واحد فقط في كل مرة. بدون هذا، تعديلان معتمدان يهبطان على الإصدار نفسه ليس افتراضاً.

4. دوّن قاعدة الرئيسي مقابل الفرعي قبل أن تحتاجها أول وثيقة

   حدّد، في الوثيقة نفسها التي تعرّف نظام الترقيم، بالضبط ما يُحفّز خطوة الرقم الصحيح: الاعتماد الرسمي وحده، أو الاعتماد مع إعادة كتابة جوهرية. فريق يقرّر هذا حالة بحالة ينتهي بوثيقتين مختلفتين تُسمَّيان كلتاهما الإصدار 2.0.

5. سجّل كل مراجعة دورية، بما فيها التي لا تغيّر شيئاً

   امنح خطوة المراجعة شكل قرار بمخرج مُسمّى «لا تغيير» يكتب قيداً مؤرَّخاً في السجل، بالطريقة نفسها التي يصل بها «هل طُلب تغيير بعد النشر؟» إلى «الإصدار الحالي يبقى سارياً» بدل ألا يفعل شيئاً ببساطة. القيد المفقود ينبغي أن يعني أن المراجعة لم تحدث، لا أن لا شيء حدث في أثنائها.

6. دع نسخة حية معتمَدة واحدة تزيل مشكلة القفل كلياً

   افتح الوثيقة كمخطط QueryChart بدل مجموعة ملفات مُتبادَلة بالبريد، فلا يوجد سوى إصدار حالي واحد للتحرير: يُلتقط كل حفظ كقيد جديد في سجل التغييرات تلقائياً، فلا يبقى لاصطلاح تسجيل الخروج شيء يفرضه. راجع /features/version-control.

أخطاء ينبغي تجنّبها

• إعادة الترقيم لإصلاح خطأ

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

• رقم الإصدار الذي يعيش فقط في اسم الملف

  «Policy_v3_FINAL.docx» لا يخبر أحداً بشيء بمجرد أن يُطبَع أو يُعاد توجيهه أو يُنسَخ دون اسمه. ضع الإصدار والتاريخ والمعتمِد داخل الوثيقة نفسها، في المكان الثابت نفسه كل مرة.

• نسختان «حاليتان» تُحرَّران في بعد الظهر نفسه

  تُحرَّر نسخة على قرص مشترك ونسخة مُرسَلة بالبريد كلتاهما كأن كلاً منهما الأصل، فتُكتب المجموعتان من التعديلات فوق بعضهما بصمت أو تتفرّعان. أصلح هذا باصطلاح تسجيل خروج، أو أفضل، نسخة حية معتمَدة واحدة؛ راجع /features/version-control.

• مراجعة لا تترك أثراً حين لا يتغيّر شيء

  وثيقة رُوجِعت ووُجدت ما زالت دقيقة، دون قيد في أي مكان، لا تُميَّز بعد عام عن وثيقة لم يراجعها أحد قط. امنح «لا تغيير مطلوب» سطره المؤرَّخ الخاص في السجل، بالطريقة نفسها التي يصل بها فرع لا في صف قرار مع ذلك إلى نتيجة مُسمّاة.

طبّق هذه الممارسات على وثيقتك الخاصة

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

طبّق هذه الممارسات على وثيقتك الخاصة

أدلة ذات صلة

• ضبط الإصدار مقابل ضبط التغيير: ما الفرق
• كيفية تتبع التغييرات في عملية
• كيفية إنشاء سير عمل اعتماد الوثائق

الأسئلة الشائعة

ما أكبر خطأ واحد في ضبط إصدار الوثائق ينبغي تجنّبه؟

معاملة النظام كثابت فقط حتى يجد أحدهم سبباً لتغييره. إعادة ترقيم مكتبة قائمة (حتى لإصلاح عيب حقيقي) تكسر كل إحالة متقاطعة وسجل تدريب واستشهاد تدقيق سمّى الأرقام القديمة، وتلك الكلفة تتجاوز دائماً تقريباً كلفة العيش مع نظام غير كامل. أصلح المشاكل مستقبلاً باستثناء موثَّق، لا بلمس ما صدر أصلاً.

كيف أوقف شخصين عن تحرير الإصدار «الحالي» نفسه في آن واحد؟

إما أضف اصطلاح تسجيل خروج صريح (علامة في السجل تُظهر من يفتح الوثيقة، كي يعرف معِدّ ثانٍ أن ينتظر) أو أزل الاحتمال هيكلياً بالاحتفاظ بنسخة حية معتمَدة واحدة بالضبط بدل ملفات مُتبادَلة بالبريد أو قرص مشترك. يفعل QueryChart الثاني: كل وثيقة مخطط حي واحد، ويُرقِّم كل حفظ تلقائياً، ولا توجد نسخة ثانية لتتفرّع. راجع /features/version-control.

ما الذي ينبغي أن يُحسب إصداراً رئيسياً مقابل فرعياً؟

لا توجد قاعدة عامة، ولهذا بالضبط ينبغي كتابتها قبل أن تحتاجها أول وثيقة لا تُحكَم حالة بحالة. يربط اصطلاح شائع خطوة الرقم الصحيح الرئيسية بالاعتماد الرسمي وحده (كل تنقيح مسودة بينهما، مهما كان جوهرياً، يبقى عشرياً) كي لا يُتناقَش أبداً «كم كان التغيير كبيراً» لحظة منح رقم إصدار.

هل أحتاج تسجيل مراجعة دورية لم تجد تغييرات مطلوبة؟

نعم، مراجعة غير مُسجَّلة لا تُميَّز عن مراجعة لم تحدث قط. امنح خطوة المراجعة في عمليتك شكل قرار بمخرج مُسمّى لـ«لا تغيير مطلوب» ما زال يكتب قيداً مؤرَّخاً في السجل، بالطريقة نفسها التي يسجّل بها صف قرار في مخطط كل فرع يسلكه، لا الفروع التي تقود إلى شيء جديد فقط.