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

Question

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

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

Tengo una idea amplia de lo que se debe incluir en un documento de soporte, pero hasta ahora no he necesitado muchos documentos de apoyo y quiero una lista sólida de elementos para incluir.

Creo que mi meta es hacer las vidas de todos en el grupo de apoyo más fácil y libre de estrés como sea posible.

así que supongo que mis preguntas son:

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

2. Qué cosas adicionales tienen que poner en los documentos de apoyo para hacerlos extraordinariamente útil.

3. ¿Qué otras actividades se pueden hacer antes de la entrega para facilitar nuestras vidas?

Answer 1

Después de haber estado en ambos lados de este proceso profesionalmente, puedo decir que lo siguiente debe ser obligatoria:

• la documentación del código (javadoc, doxygen, etc)
• detalles en proceso de construcción
  • dónde obtener fuente de corriente
  • cómo presentar errores (pasarán)
  • ruta para proporcionar parches o bien a la fuente o para clientes
• cómo funciona (simple, pero a menudo se pasa por alto)
• porciones personalizables por el usuario (por ejemplo, hay es un componente de script)
• contactos primarios para cada componente, también conocido como vía de escalamiento
• estímulo para la retroalimentación de apoyo en cuanto a lo demá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. incluir capturas de pantalla de las operaciones y de salida.
2. Prefiere el documento "en línea fácilmente actualizable" (wiki-like) en lugar de papel o pdf.
3. Si está en línea, hágalo buscar y reticular.

Answer 3

• Un usermanual es una cosa ordenada (imágenes, descripciones, de Aso.)
• Un resumen de las diferentes funciones dentro de la aplicación

eso es lo que estoy pensando sábana de la cabeza si esto es "solo" para el personal de soporte y no para un mayor desarrollo.

Answer 4

Si es posible, solicite al personal de asistencia que empareje el programa con usted para solucionar los últimos errores.

Answer 5

1. especificación funcional (Si lo tiene)
2. Manual del usuario. Crea uno si usted no tiene
3. Manual Técnico, que contiene
   • diagrama de despliegue
   • Softwares usados ​​
   • configuración y construir detalles
   • deatils de IP del servidor y contraseñas de administrador/Oracle/WebSphere
4. Documento de prueba
5. Sobre el documento de vista
   • Cuando todos los documentos se mantienen repositorio
   • de control de versiones y sus detalles de proyecto/usuario
   • nombres de usuario de Aplicación/contraseña
6. /herramientas de Cualquier SQL apoyo etc creado por el equipo de desarrollo, para el análisis, carga de datos, etc.