ما نوع المعلومات التي ستدخل في وثائق النشر الجيدة؟[مغلق]

Question

أخوض معارك مستمرة مع زملائي فيما يتعلق بتكوين وثائق النشر.

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

ما الذي وجدته يعمل بشكل أفضل بالنسبة لك؟

Answer 1

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

1. ملخص لما يدور حوله الإصدار، وما الذي تغير، والإصدار، وأين يمكن العثور على ملف الحل وما إلى ذلك.
2. قائمة التبعيات المحتملة
3. إجراءات النشر التفصيلية
4. تغييرات قاعدة البيانات أو البرامج النصية المطلوبة للتثبيت
5. ملخص التكوين حول كيفية تكوين التطبيق.
6. اختبار وظيفي رئيسي يمكن تشغيله للتحقق من أن التثبيت جاهز للعمل.
7. إجراء الاستعادة - إذا لزم الأمر.

Answer 2

ولقد وجدت أن بناء أداة تسمح لضغطة واحدة نشر أفضل بكثير من الوثائق نشر شاملة.

Answer 3

ما هو الغرض من وثائق؟ نبدأ من هناك، ومعرفة ما يلبي هذا الهدف.

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

في كل حالة على حدة، واستند مستوى التفاصيل على النظام وما يحتاج أحد أعضاء الفريق الجديد لتنفيذ التحديثات ونشر جديدة.