كيفية إنشاء سجل تنقيحات وثيقة

كيف تعمل

1. افصل السجل عن الوثيقة

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

2. ثبّت الأعمدة قبل القيد الأول

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

3. افتح القيد قبل التعديل، لا بعده

   سجّل قيداً معلّقاً (رقم، ورابط الوثيقة، ومعِدّ مُسنَد) لحظة اعتماد التغيير، قبل أن يفتح أحد الملف. القيد المكتوب بعد وقوع التغيير يُعاد بناؤه من الذاكرة، وهو بالضبط نمط الفشل الذي وُجد السجل لمنعه.

4. اكتب ما تغيّر، لا أن شيئاً تغيّر

   «تحديث القسم 4» ليس وصفاً؛ «تغيير عتبة الاعتماد من 500 دولار إلى 2,000 دولار في القسم 4» كذلك. سجّل القبل والبعد بعبارات واضحة، واسم المعِدّ والتاريخ، كي يستطيع القارئ إعادة بناء التغيير دون فتح تاريخ الوثيقة نفسه.

5. تحقّق من القيد مقابل التعديل الحقيقي

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

6. خذ عيّنة من القيود المُغلَقة، لا راجع كلاً منها

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

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

ما الفرق بين سجل التنقيحات وضبط الإصدار؟

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

ما الأعمدة التي يحتاجها جدول سجل التنقيحات؟

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

هل ينبغي تحرير سجل تنقيحات لإصلاح خطأ في قيد قديم؟

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

هل جدول بيانات محفوظ يدوياً كافٍ لسجل تنقيحات، أم أحتاج برمجية؟

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