Con cualquier proyecto de desarrollo, lo mejor que puede hacer es documentar y limpiar el código.
Código limpio:
- Siguiendo un estándar de codificación, asegurándose de que cada archivo se vea y se sienta igual para el desarrollador. Esto incluye un buen espacio, comentarios y funcionalidades en fragmentos lógicos (funciones / métodos)
- Seguir un estándar de nomenclatura para variables, funciones, clases, métodos y archivos
La documentación puede y debe venir en dos formas:
- ¿Cómo uso el QueryStringField en asp.net?
- ¿Por qué los bloques Ruby no se pueden almacenar directamente en variables?
- Al descargar una copia de los datos (de Google), ¿cómo la usa o abre un archivo JSON?
- ¿Cuál es el uso de JS en un diseño de sitio web?
- ¿Cómo escribo un programa donde un usuario crea un nombre de usuario para iniciar sesión y también obtiene ese nombre de usuario en mydomain.com/username?
- En los comentarios de código que explican con precisión lo que está sucediendo en cada archivo y en cada paso principal a través del código
- Fuera de la documentación del código que explica la vista general de cada componente principal, qué hace y cómo interactúa con el resto del sistema.
Siempre habrá una curva de aprendizaje con gente nueva. Es la realidad del mundo, pero puede aliviar la mayor parte al tener una dedicación constante para limpiar el código y la documentación.
