Estoy trabajando en un proyecto web en java y tengo un problema con la documentación. El objetivo que estoy persiguiendo es tener paso a paso como hacer una serie de cosas básicas para el mantenimiento del sistema, como por ej: agregar un campo a un reporte, para tener una guía para mí y para otro programador y mantener el código homogéneo.
Para esto tengo varios documentos de Word con capturas de pantalla y explicación paso por paso de cómo hacer las cosas en el código del proyecto, También tenemos comentado el código pero no marca paso a paso lo que hay que hacer.
El IDE de desarrollo que usamos es Intellij IDEA Ultimate.
El problema que tenemos es que los Word no son cómodos, porque tiene muchas paginas con un índice grande (alrededor de 175) y lleva mucho tiempo mantenerlo cuando hacemos un cambio. Por ej: ahora estamos cambiando la versión del IDE y para cambiar y adaptar las capturas de pantallas nos llevara mas o menos un par de horas de trabajo extra.
También hemos probado usando Wikis (como el tikiwiki), pero era difícil de mantener con imágenes y no nos sentíamos muy cómodo usándolo.
1- ¿de qué forma se podría manejar mejor esta documentación cumpliendo mi objetivo?
2- ¿Existe alguna forma práctica de integrarlo al IDE?
Saludos y Gracias