Mal software NO documentado
Que tal comunidad!
Me gustaría saber sugerencias y recomendaciones para poder documentar un proyecto.
El proyecto ya está hecho, lo hizo un programador que ya no está a cargo de él y me dejó su herencia: Un proyecto sin documentación y con nombres de los componentes que no tienen nada que ver con el negocio.
Lo que quiero reflejar en la documentación es lo siguiente:
• ¿Qué es lo que hace el proyecto?
• ¿Qué archivos de configuración necesita?
• ¿Cuáles son las salidas y las entradas?
• ¿A qué bases de datos accesa, etc?
Ya todo lo tengo analizado, conosco sus partes y su funcionamiento.
Lo único que quiero hacer es ponerlo en papel, pero en forma, para que otro programador no llegue a invertir tiempo en eso.
Tengo unos diagramas de secuencias UML para documentar el funcionamiento :/, pero no satisface todo lo demás que deseo documentar.
Por supuesto soy dummy en esto
Espero que me puedan ayudar. Saludos!
- Inicie sesión o regístrese para enviar comentarios
Re: Mal software NO documentado
Ya tienes todo entonces.
Documenta el código como tu quieras, solo es necesario que tenga lógica. Que lo escribas lo más sencillo que puedas para que otros no se confundan.
Según yo, no es necesario usar alguna herramienta especial para la documentación.
Suerte. o_0
JavaDoc
En este punto creo que sería necesario solo dos cosas:
Buena redacción y conocer JavaDoc lo demás es mera 'diversión'. >.<'