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

باختصار

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

الجدول أثر، لا الانضباط نفسه

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

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

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

ستة عشر صفاً، خمسة مسارات، قيد سجل واحد

شاهد قيد سجل تنقيحات واحداً يتحرك من الطلب إلى إغلاق مُحقَّق وجاهز للتدقيق: الأعمدة التي يتجاهلها جدول مصنوع يدوياً عادةً، مرسومة كعملية.

1. طلب، ليس قيداً بعد

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

2. القيد يُفتَح قبل التعديل

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

3. التحقق، لا الوصف فقط

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

4. تعارض، ثم إغلاق وتدقيق

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

كيف تعمل

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

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

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

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

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

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

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

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

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

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

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

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

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

• السجل كاختبار ذاكرة

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

• تحرير التاريخ في مكانه

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

• سجل لا يفحصه أحد مقابل الوثيقة

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

• الخلط بين السجل والعملية التي تنتجه

  سجل التنقيحات يسجّل ما تغيّر؛ ولا يقرّر من يستطيع اعتماد تغيير أو أين تعيش النسخ الملغاة: ذلك ضبط الوثائق، مغطى بالكامل على /ar/templates/عملية-ضبط-الوثائق. ابنِ الاثنين، لكن أبقهما أثرين منفصلين.

ابنِ سجل تنقيحاتك الخاص

افتح مخطط قيد سجل التنقيحات كقالبك الخاص، وضع أنواع وثائقك في المسارات، ودع سجل تغييرات QueryChart يحتفظ بالتاريخ المُحقَّق بدل جدول بيانات.

ابنِ سجل تنقيحاتك الخاص

أدلة ذات صلة

• كيفية ضبط إصدار إجراء تشغيل قياسي
• كيفية تتبع التغييرات في إجراء تشغيل قياسي
• كيفية إدارة تنقيحات إجراء التشغيل القياسي

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

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

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

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

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

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

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

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

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