La documentación es la clave
Mejor práctica 2: complete sus documentos antes del siguiente paso
Había obtenido mi maestría en Computación y Aplicaciones y me apasionaba escribir código fuente incluso sin comprender y documentar completamente los requisitos. El documento de diseño y la documentación de casos de prueba no estaban en ninguna parte del ciclo de vida del desarrollo de software ... hubo un salto directo a la codificación.
En etapas posteriores me encontré en un gran problema y pronto me di cuenta Documentation is the Key para convertirse en un exitoso desarrollador, probador o arquitecto de software.
Antes de comenzar a desarrollar software grande o pequeño, debe tener respuesta a las siguientes preguntas:
¿Dónde está la especificación de requisitos?
¿Dónde está el documento de análisis de impacto?
¿Dónde está el documento de diseño?
¿Ha documentado correctamente todas las suposiciones y limitaciones?
¿Ha revisado todos los documentos?
¿Obtuvo la firma de todos los documentos de todas las partes interesadas?
Una vez que tenga respuestas positivas para todas las preguntas anteriores, estará seguro y listo para continuar con la codificación. Muchas organizaciones tendrían que seguir reglas estrictas, pero otras no. La mejor práctica es completar toda la documentación requerida y tomar las aprobaciones apropiadas antes de continuar con la codificación del software.
¡Lo que aprendes hoy te prepara para mañana!
Entonces, nuevamente, una de las mejores prácticas es tener la mayor cantidad de documentación posible. Algunos documentos importantes que lo prepararán para el futuro son:
- Enfoques de diseño
- Consejos y trucos
- Funciones, comandos e instrucciones especiales
- Lecciones aprendidas
- Situaciones peculiares
- Métodos de depuración
- Mejores prácticas
- Cualquier cosa que pueda ayudarte en el futuro.
Mantener los documentos de forma electrónica no le cuesta nada. Así que comencemos a mantener la documentación requerida.