Documentación es la clave

Mejores Prácticas 2 - Complete sus documentos antes del próximo paso

Yo había pasado mi máster en Informática y aplicación, y era tan apasionado para escribir código fuente aun sin comprender y documentar completamente los requisitos. Documento de diseño y los casos de prueba en ninguna documentación en el ciclo de vida del desarrollo de software... se salta directo a la codificación.

En las etapas posteriores me he encontrado en un gran problema y pronto me di cuenta documentación es la clave para ser exitoso software developer, tester o arquitecto.

Antes de que usted comience a desarrollar software más grandes o más pequeñas, usted debe tener respuesta para las siguientes preguntas:

• ¿Dónde está la especificación de los requisitos?

• ¿Dónde está el análisis de impacto Documento?

• ¿Dónde está el Documento de diseño?

• ¿Ha documentado todos los supuestos, limitaciones correctamente?

• ¿Ha hecho examen de todos los documentos?

• ¿Habéis conseguido firmar apagado en todos los documentos de todos los interesados?

Una vez que usted haya respuestas positivas para todas las preguntas anteriores, usted está seguro y listo para proceder a la codificación. Muchas organizaciones que tienen normas estrictas que han de seguirse, pero otros no tienen. Lo mejor es completar toda la documentación requerida y las autorizaciones necesarias antes de proceder a la codificación de software.

Lo que se aprende hoy, te prepara para el día de mañana!

Así que, una vez más, es una de las mejores prácticas de contar con la documentación en la medida de lo posible. Algunos documentos importantes, lo que le preparará para el futuro son:

• Enfoques de diseño
• Consejos y trucos
• Funciones especiales, comandos e instrucciones
• Lecciones aprendidas
• Situaciones especiales
• Métodos de depuración
• Mejores prácticas
• Cualquier cosa que pueda ayudar a que en el futuro

Mantener los documentos electrónicamente no le cuestan. Así pues, empecemos conservar la documentación necesaria.