Unidad didáctica 7 DOCUMENTACIÓN DE APLICACIONES WEB
––Declaración de trabajo, ––Solicitud de propuestas ––Propuestas. Proporciona una visión general de la documentación de usuario del software y de los procesos de gestión de la información que puede requerir la adquisición y suministro de documentación de usuario. Se dirige a la preparación de los requisitos para la documentación de usuario del software, ya que estos requisitos son fundamentales para la especificación de la documentación de usuario y la Declaración de Trabajo. Incluye requisitos para salidas de documentos primarios del proceso de adquisición y suministro: la solicitud de propuesta y la propuesta de productos y servicios de documentación del usuario. También se discute el uso de un plan de gestión de documentación y un Plan de documento que se presenten en los procesos de adquisición y suministro. Esta norma es independiente de las herramientas de software que pueden ser utilizados para producir la documentación, y se aplica tanto a la documentación impresa como a la documentación online. 7.7 Herramientas de documentación. 7.7.1 Generación automática de documentación técnica. Como se ha comentado en un punto anterior, existen herramientas para la generación automática de documentación técnica, las cuales se basan en los comentarios del código entre otros elementos del mismo y generan una documentación en formato texto o html, como formatos más habituales. Esta documentación creada automáticamente se suele organizar en estilo guía de referencia para poder permitir la búsqueda rápida de una función u otro elemento de la programación. Al ser obtenida a partir del código fuente de forma automática, hace más fácil su mantenimiento. Algunos ejemplos de herramientas para la generación automática de documentación de código son:
209