¿cual es la forma de documentar un sistema en Delphi?

[[Delphius]]

Empezado por maeyanes

Delphius, te faltó el manual de usuario...

Cierto, cierto... ¡Menuda cosa!
Ha... y por cierto, ya con esto infarto seguro... Hay dos tipos de manuales de usuario: el del usuario final y el manual técnico

Ha... ya sea de paso, digo... mejor vamos buscando el cajón porque todavía no se acaba. Luego de generar todita la documentación (proyecto + sistema + manuales) viene algo más chungo y más PRO... ¿quien adivina? ¿O es que se quieren evitar un infarto?

Luego viene documentación a nivel de empresa. Sacar conclusiones, generar ciertos informes que nos puede ser útil para saber como se hicieron las cosas. Mucha documentación que se lleva por cada proyecto puede ser empleada para generar otra más, que sea de utilidad para saber como encarar nuevos proyectos y reorganizar nuestro trabajo y redefinir nuestro propio método.
Por ejemplo: llegar a elaborar nuestro propio framerork, nuestras propias políticas de como llevar el dichoso control de versiones, etc.

En el caso del framerork es algo similar a la documentación para el sistema. Si analizamos los diferentes trabajos notamos que tener nuestras bibliotecas, nuestras clases, métodos, funciones y procedimientos nos puede ser de mucha ayuda a reducir nuestras actividades y además tiene el potencial de ser reutilizada. La pregunta aquí es ¿Y cómo sabemos si tenemos algo ya en nuestra biblioteca? Fáci... ¡documente mijo!

Y aquí el trabajo es doble, porque es natural que esta mega biblioteca o framework evolucione, cambie, se mejore... ¡Otra vez la burra al trigo con las versiones y las pruebas!

Para llegado el momento, si no tuvimos un infarto seguramente ya estemos por el doble Bypass. (y no me refiero a éstos ByPass).

Saludos,