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

Question

أنا خلقت التطبيق الذي يحتاج 'تسليم' إلى فريق الدعم في الشهر المقبل.

التطبيق صغيرة إلى حد ما (2 أشهر التنمية) و يتكون من اثنين من جانب العميل تطبيقات قاعدة البيانات ، هو مكتوب في c# للمنصة ويندوز.

لدي فكرة واسعة ما أن تدرج في وثيقة الدعم ، ولكن لم اللازمة لجعل عدد كبير جدا من مستندات الدعم حتى الآن في مسيرتي وأريد صلبة قائمة البنود التي تشمل.

أعتقد الهدف هو جعل حياة الجميع في مجموعة الدعم أسهل و خالية قدر الإمكان من الإجهاد.

لذا أعتقد أن أسئلتي هي:

1. ماذا يجب على دعم وثيقة تحتوي على الاطلاق

2. ما الأشياء الإضافية وضعت في وثائق الدعم لجعلها إضافية مفيدة.

3. ما الأنشطة الأخرى يمكن القيام به قبل تسليم لجعل حياتنا أسهل ؟

Answer 1

بعد أن كان على كلا الجانبين من هذه العملية مهنيا, أستطيع أن أقول أنه ينبغي أن إلزامية:

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

أنا متأكد أن الكثير من الأشياء الأخرى التي يمكن أن تضاف ، ولكن هذه هي أولوية قصوى في ذهني.

Answer 2

1. المواصفات الفنية (إذا كان لديك واحدة)
2. دليل المستخدم.إنشاء واحد إذا لم يكن لديك
3. الدليل الفني, تحتوي على
   • نشر الرسم البياني
   • البرمجيات المستخدمة
   • تكوين وبناء التفاصيل
   • عملية خط ip الخادم و المشرف / أوراكل / websphere كلمات السر
4. اختبار الوثيقة
5. على عرض الوثيقة إعطاء
   • حيث جميع الوثائق تحفظ
   • التحكم في الإصدار مستودع و المشروع/ تفاصيل المستخدم
   • التطبيق اسم المستخدم / كلمة المرور
6. أي دعم SQL هو/أدوات الخ إنشاؤه من قبل فريق التطوير ، تحليل, تحميل البيانات وما إلى ذلك.

Answer 3

1. وتشمل لقطات من عمليات الإخراج.
2. تفضل "على الانترنت بسهولة تحديث قادرة" doc (ويكي-مثل) بدلا من الورق أو pdf.
3. إذا على الانترنت ، وجعلها قابلة للبحث و عبر ربط.

Answer 4

• أ usermanual هو شيء أنيق (الصور والأوصاف ، اسو.)
• المتهدمة من ميزات مختلفة داخل التطبيق

هذا ما أفكر ontop رأسي إذا كان هذا هو "فقط" من أجل دعم الموظفين و لا مزيد من التطوير.