¿Qué tipo de información entraría en una buena documentación de implementación? [cerrado]

Question

Tengo estas batallas constantes con mis colegas con respecto a la composición de la documentación de implementación.

Todos aceptan que la documentación es necesaria. No todos pueden encontrar un terreno común sobre qué nivel de detalle debe entrar en esto, especialmente diferenciando entre lanzamientos grandes, correcciones de errores y mejoras.

¿Qué has encontrado que funciona mejor para ti?

Answer 1

Si su propósito de la documentación es asegurar que el código se implemente de manera repetible, entonces la siguiente sería la práctica mínima recomendada:

1. Un resumen de qué trata el lanzamiento, qué cambió, versión, dónde se puede encontrar el archivo de solución, etc.
2. Lista de posibles dependencias
3. Procedimientos detallados de implementación
4. Cambios en la base de datos o scripts necesarios para la instalación
5. Resumen de configuración sobre cómo se configura la aplicación.
6. Prueba funcional clave que se puede ejecutar para verificar que la instalación esté operativa.
7. Procedimiento de reversión - si es necesario.

Answer 2

He descubierto que crear una herramienta que permita una implementación con un solo clic es mucho mejor que una documentación de implementación completa.

Answer 3

¿Cuál es el propósito de su documentación? Comience desde allí y calcule qué cumple con ese objetivo.

Para nosotros, nuestro objetivo era permitir que alguien completamente nuevo en el grupo pudiera ejecutar una implementación nueva o actualizada para algunos sistemas diferentes. Estamos operando un tipo de operación de lo más fácil: servicios de Windows, trabajos cron, copias de seguridad de bases de datos, actualizaciones de sitios web, etc.

En cada caso, el nivel de detalle se basó en el sistema y en lo que un nuevo miembro del equipo necesitaría para ejecutar actualizaciones y nuevas implementaciones.