Cómo documentar componentes de software

Documentar componentes de software en la fase de oferta y diseño de tu solución es ahora una tarea sencilla con esta guía y su plantilla asociada.
 
Por componente de software entendemos cualquier módulo, proceso, librería, base de datos, aplicación de usuario, informe, etc., que pertenece al sistema a desarrollar. Son los elementos que forman la arquitectura software de tu sistema y que documentarás en las especificaciones técnicas.

Existen múltiples formas de documentar los componentes y la información relacionada irá variando en función de la fase del proyecto en la que te encuentres. Esta guía y la plantilla que encontrarás adjunta, hacen referencia a la fase de diseño donde se necesita identificar los componentes principales y las relaciones entre ellos.

También es de utilidad en la fase de oferta ya que, tal y como se describe en el libro Los Secretos del Software Industrial, el diseño preliminar del sistema se realiza en fase de oferta.

Por último, puedes incorporar esta información en el manual de mantenimiento para mostrarle al cliente la arquitectura general del sistema y cuáles son los principales componentes.

Que Incluye

• La guía para aprender a documentar componentes de software
• La plantilla para su definición