¿Cuáles son los elementos centrales para incluir en la documentación de soporte? [cerrado]

Question

He creado una aplicación que necesita 'entrega' al grupo de soporte en el próximo mes.

La aplicación es bastante pequeña (desarrollo de 2 meses), y consta de dos aplicaciones del lado del cliente y una base de datos, está escrita en c # para la plataforma de Windows.

Tengo una idea amplia de qué incluir en un documento de soporte, pero no he necesitado hacer muchos documentos de soporte en mi carrera hasta ahora y quiero una lista sólida de elementos para incluir.

Supongo que mi objetivo es hacer que la vida de todos en el grupo de apoyo sea más fácil y lo más libre de estrés posible.

Así que supongo que mis preguntas son:

1. ¿Qué debe contener absolutamente un documento de soporte

2. ¿Qué cosas adicionales ha puesto en los documentos de soporte para que sean más útiles?

3. ¿Qué otras actividades se pueden hacer antes de la entrega para hacer que todas nuestras vidas sean más fáciles?

Answer 1

Habiendo estado en ambos lados de este proceso profesionalmente, puedo decir que lo siguiente debería ser mandatory :

• la documentación del código (javadoc, doxygen, etc.)
• detalles sobre el proceso de construcción
  • dónde obtener la fuente actual
  • cómo archivar errores (ocurrirán)
  • ruta para proporcionar parches a la fuente o a los clientes
• cómo funciona (simple, pero a menudo se pasa por alto)
• partes personalizables por el usuario (por ejemplo, hay un componente de secuencias de comandos)
• contactos principales para cada componente, también conocido como ruta de escalada
• estímulo para la retroalimentación del Soporte sobre qué más quieren ver

Estoy seguro de que se pueden agregar muchas otras cosas, pero estas son las principales prioridades en mi mente.

Answer 2

1. Especificación funcional (si tiene una)
2. Manual del usuario. Crea uno si no tienes
3. Manual técnico, que contiene
   • Diagrama de implementación
   • Software utilizado
   • Detalles de configuración y compilación
   • Deatils of Server ip y admin / oracle / websphere passwords
4. Documento de prueba
5. Sobre el documento de vista dando
   • Donde se guardan todos los documentos
   • Repositorio de control de versiones y sus detalles de proyecto / usuario
   • Nombres de usuario de la aplicación / contraseña
6. Cualquier soporte SQL / herramientas, etc., creado por el equipo de desarrollo, para análisis, carga de datos, etc.

Answer 3

1. Incluir capturas de pantalla de operaciones y resultados.
2. Prefiero "en línea fácilmente actualizable" doc (similar a wiki) en lugar de papel o pdf.
3. Si está en línea, haga que se pueda realizar búsquedas y enlaces cruzados.

Answer 4

• Un manual de usuario es una buena cosa (fotos, descripciones, aso.)
• Un resumen de las diferentes características dentro de la aplicación

Eso es lo que estoy pensando en lo alto de mi cabeza si esto es " solo " para el personal de apoyo y no más desarrollo.