الوثائق يوفر مسارات المراجعة للعمل الذي أنجز

# 13 : وثيقة كل شيء

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

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

2. والثانية هي جمهور في وقت ما في المستقبل. الناس الذين يحافظون على نظم وتطبيقات اليوم لن يكون إلى الأبد. وأنت لا يمكن أن نفترض أن أي الموظفين ذوي الخبرة ستكون حوالي معلمه للقادمين الجدد. يجب الاستعداد لنزوح أعداد ضخمة من الناس من ذوي الخبرة الخاصة بك. وتقول لافتة شعبية على مسؤولي النظام العديد من المكاتب ما يلي : "تذكر ، 100 سنة من الآن ، كل الناس جديد!"

3. الجمهور الثالث هو الإدارة. تلاحظ حفظ وتوثيق جيد يساعد على عملكم تثبت للإدارة التي كنت قد الدؤوب ويبين ما هي التدابير التي اتخذت للحفاظ على أنظمة تشغيل ومنتجة. إذا كان النظام لا يستوفي الشروط المنصوص عليها في الوثائق ، فإنه ينبغي أن يكون من السهل معرفة السبب وتحديد ما يجب عمله لجعل النظام متوافقة. حتى لو كان لديك إدارة لا يفهم قيمة الخدمات التي تقدمها للمنظمة ، فإنها عادة ما فهم قيمة عندما تقدم في شكل كومة كثيفة من الوثائق.

تأكد من أن الوثائق المخزنة على الورق أيضا. إذا كان النظام باستمرار عندما تحتاج إلى أدلة ، أنت لن تكون قادرة على الوصول إليهم. الاحتفاظ بها في ملفات بحيث يمكن بسهولة تعديل وتحديث. بعد وثائق مكتوبة ، لا ننسى لإعادة النظر فيها وتحديثها على أساس منتظم. ثائق السيئ هو أسوأ من لا شيء على الإطلاق. في أزمة ، وخاصة إذا كان معظم الناس ليسوا على دراية حولها ، والوثائق ومن المرجح أن يتبع حرفيا. لو كان خطأ ، يمكن أن تسير الأمور من سيئ إلى أسوأ ، وهناك مسألة مشتركة حول إعداد الوثائق وعلى أي مستوى التقنية التي ينبغي أن تكون مكتوبة. مدرسة فكرية واحدة تقول ان الوثائق يجب أن تكون مكتوبة بحيث يستطيع كل شخص في المؤسسة ، من البواب إلى المدير التنفيذي ، ويمكن أن يتبع ذلك ، إذا اقتضى الأمر ، وجعل النظم حتى بعد وقوع الكارثة. بعد كل شيء ، يمكن للنظام الموظفين الإداريين لا تكون متاحة في ذلك الوقت ، وشخص لديه للقيام بذلك. بينما يعتبر هذا الهدف النبيل ، واحد لا غير عملي. حالة تغييرات النظم الحيوية في كل وقت. لمزيد من التفصيل الذي تم تضمينه في تلك الوثائق ، وأسرع يصبح خارج التاريخ. من أجل كتابة الوثائق حتى يتسنى لشخص غير مدربين أنظمة ذكية يمكن أن يحقق أعلى أو لغيرها القيام بعمل حاسم بشأنها في وقت الأزمات ، فإنه يجب أن تكون مفصلة بحيث يكون لا يمكن السيطرة عليها. وإذا كانت المهمة هي في متناول اليد لتحرير ملف ل تغيير متغير واحد إلى آخر ، لمدربين تدريبا مناسبا المسؤول عن النظام ، فإن الوثائق تحتاج فقط إلى القول ، "تغيير اي بي سي لس ع ص) في الدليل / / file.txt." بالنسبة لشخص ذكي غير مدربين ، فإن الوثائق بحاجة إلى أن أقول :

1. تغيير الدليل إلى الدليل / بكتابة "مؤتمر نزع السلاح / الدليل".

2. فتح السادس محرر النص بكتابة "سادسا file.txt".

3. تحرك المؤشر نزولا الى 300 خط بكتابة "300G".

وهلم جرا (في أي بيئة التشغيل المناسبة). في كل مرة عدد سطر في ملف تغيرت ، فإن وثائق قد تكون تغيرت. الخطأ كثير من الظروف سيكون من الضروري التعامل معها بالنسبة للشخص عديم الخبرة وكذلك ، على سبيل المثال ، إذا كان نوع المحطة أو العد خط يتم تعيين خاطئ ، المحرر السادس قد تواجه مشكلة في التعامل معها. في هذه الحالة ، ما الذي يجب على الشخص عديم الخبرة نفعل؟ والجواب الصحيح ، لذلك ، هو أن يكتب وثائق بحيث متمرس مسؤول النظام يمكن استخدامه. لا نتوقع من المسؤول أن لديها قدر كبير من الخبرة في متجرك ، مجرد تجربة عامة. في بيئة ويندوز ، والهدف من مهندس معتمد من مايكروسوفت (MSCE). في بيئات يونيكس والإداريين هدف النظام من ذوي الخبرة. اذا حدث شيء ما للنظام الحالي الموظفين الإداريين ، يمكنك المعقول أن نفترض أنه سيتم الاستعاضة عنها الناس من ذوي الخبرة. التوثيق هو يشبه إلى حد كبير الغرامة قطعة من الأدب. الجميع يريد ان يقول ان لديهم قراءة موبي ديك ، ولكن لا أحد يريد فعلا الجلوس وقراءة موبي ديك.

# 12 : توظيف اتفاقيات مستوى الخدمات

# 11 : الخطة القادمة

---

تنويه :موقعنا على الانترنت ليست مسؤولة عن محتوى هذه المادة. Webarticles هو حر للمعلومات.
المهم : هذه المادة "الوثائق يوفر مسارات المراجعة للعمل الذي أنجز" وقد ترجم من قبل البرمجيات التلقائي. نشعر بالاسف من اجل أي الأخطاء الإملائية التي قد حدث. شكرا لتفهمكم.

---