الدعم التقني / التشخيص المركب ومسؤولية الخدمة / الدرس 17
التوثيق ومعرفة الدعم القابلة للصيانة
حوّل النتيجة المتحققة لتعليمات قابلة للإعادة بنطاق وحدود وخصوصية ومراجعة.
في هذه الصفحة
أهداف الدرس
- اكتب مقالة يفهمها قارئ مصرح آخر بأمان.
- افصل دليل التذكرة الخاصة من الإرشاد المعاد.
التوثيق واجهة تشغيلية
تحدد المقالة الغرض والمنتج والنسخة والسياق والشروط والأعراض والرصد والتفسير وحد الفعل والتحقق والتعافي والتصعيد والمالك. تساعد علىمطابقة الحالة قبل الإجراء. قد تضلل أوامر من حادثة أخرى؛ فاشرح الدليل وحده وميّز المختبر من المستنتج ولا تدع تنفيذاً لم يقع.
لا يثبت اكتمال الحقول جودة المقالة
يفتقد المثال معيار التحقق، ويكشفه الفحص شكلياً لا أماناً أو دقة أو حداثة. وتظل الحقول الغامضة رديئة وإن اكتملت. يجب أن يكشف المتوقع عدم المطابقة؛ ووثق للتغيير الحقيقي التصريح والتعافي، فلا تمنح المقالة سلطة التشغيل.
article = {'id': 'LAB-KB-01', 'purpose': 'explain a synthetic comparison',
'scope': 'offline fixture', 'observations': 'declared values only',
'limitations': 'not a host diagnosis', 'owner': 'lab-support'}
required = {'purpose', 'scope', 'observations', 'limitations', 'owner', 'verification'}
print('missing=' + ','.join(sorted(required - article.keys())))
missing=verification
يغيب verification، والمعرّف تعليمي لا مقالة بائع أو شهادة. لا نقرأ أو نحدث نظام محتوى أو نخول إجراء.
احفظ المعنى التقني والسياق المدعوم
احفظ الخطأ والوحدة والوقت والافتراض والإصدار واشرح الاختصار وافصل العرض من النتيجة. قد يتغير المسار والدعم بالنسخة والقناة والسياسة. اربط مصدراً رسمياً وحدّث تاريخ مراجعة حقيقية لا زيارة. حدد متى لا تنطبق المقالة والتصعيد دون علاج عام غير مختبر.
ليست المقالة المعادة نسخة تذكرة خاصة
قد تضم التذكرة أسماء ومسارات ورسائل وأسراراً لا تناسب الجمهور. انشر اللازم مع أمثلة اصطناعية واحفظ المقيد وفق السياسة. ترشح القائمة الحقول لا كل قيمة؛ فقد يكشف الملخص خصوصية. راجع الجمهور والمحتوى ولا تغير الخطأ أو شرطاً تقنياً مهماً أثناء الحجب.
case = {'summary': 'lab file access is denied', 'error': 'Access is denied',
'private_user': 'LAB-USER-A', 'private_evidence': 'restricted synthetic reference'}
article = {k: v for k, v in case.items() if k in {'summary', 'error'}}
print('published_fields=' + ','.join(sorted(article)))
print(f'private_fields_present={any(k.startswith("private_") for k in article)}')
published_fields=error,summary
private_fields_present=False
يبقى error و summary وتغيب الحقول الخاصة بأكملها من قيم اصطناعية. لا يعمم البرنامج إخفاء الهوية أو يعتمد نشراً فعلياً.
عين مالك المراجعة والتقاعد
تحتاج المعرفة مالكاً وتغذية راجعة وسياق إصدار ومعيار تصحيح أو تقاعد. اربط التكرار دون خصوصية واحفظ السبب والمختبر لإعادة التقييم. قد يبطل رابط معطل أو دعم منته إجراءً قديماً. ننشئ محتوى تعليمياً في المستودع فقط ولا ننشر خارجياً أو نعدل مكتباً أو نقرأ قضايا أو نجدول مهام.
الأخطاء الشائعة وإصلاحها
نشر قائمة أوامر كعلاج عام.
- لماذا يحدث؟
- حُذف سياق القضية وتصريحها.
- كيف تصلحه؟
- حدد التطبيق والدليل والحد والسلطة والتحقق.
- كيف تتجنب تكراره؟
- احفظ السياق والنطاق المختبر.
لصق تذكرة خاصة بمقالة أوسع.
- لماذا يحدث؟
- أُهمل الجمهور والاحتفاظ.
- كيف تصلحه؟
- عمم واحجب بالمراجعة واحفظ المقيد منفصلاً.
- كيف تتجنب تكراره؟
- راجع القيم والمعنى لا المعرّفات فقط.
ادعاء اختبار لم يُنفذ.
- لماذا يحدث؟
- رُقي الفحص النصي لدليل تنفيذ.
- كيف تصلحه؟
- اذكر الفحص الفعلي وحده المتبقي.
- كيف تتجنب تكراره؟
- سجل المصدر والإصدار والطريقة والنتيجة.
اختبر فهمك
1. ما المطلوب عند غياب حقل التحقق؟
اعرض الحل المشروح
حدد المهمة والملاحظات والبيانات وشروط التوقف والتصعيد، لا كلمة نجاح فقط. يجب أن تميز المقالة العمل من تحسين آخر أو تعاف ناقص.
2. هل يضمن حذف private_user صلاحية النشر؟
اعرض الحل المشروح
لا؛ قد تكشف بقية القيم والصور والسياق معلومات. راجع الجمهور واستخدم الاصطناعي واحفظ الدقة. الترشيح ضبط بنيوي لا إخفاء هوية كامل.
أهم ما تعلمته
- تحتاج المعرفة نطاقاً ودليلاً وتحققاً ومالكاً.
- احفظ المعنى الدقيق وافصل البيانات الخاصة.