Page 46

Software libre

© FUOC • XP06/M2118/02155

por otros miembros de la empresa sin formación de esta características. Se acuerda trabajar en formato SXW, que es el estándar de Open Office para los documentos susceptibles de sufrir modificaciones con control de correcciones y basado en una plantilla predefinida que contenga: título del documento, responsable del documento, lista de autores que han intervenido y la fecha en la cual lo han hecho, resumen ejecutivo de cambios introducidos (control de versiones) indicando cambio, fecha y autores. Asimismo, se utilizará cada documento y se generará simultáneamente en el formato PDF para su comunicación y publicación a personas vinculadas al proyecto, pero sin capacidad de introducir cambios. • Diagramas de diseño: para ellos se utilizará la notación UML. • Documentación técnica: ésta será la que probablemente más revisiones y controles deberá pasar y tendrá enlaces a las herramientas utilizadas, interfaces de programación (API), configuración y ejemplos, etc., por lo que se recomienda utilizar un formato lo más flexible posible e integrable con las propias herramientas utilizadas. Es recomendable por las características del proyecto utilizar XML para este tipo de documentación aprovechando estándares como podrían ser DocBook (http://www.docbook.org o también http:// www.oasis-open.org/docbook/) para facilitar la interacción y comprensión. Con éste se podrá:

ANOTACIONS

– Jerarquizar un documento y estructurarlo en diferentes ficheros, los cuales podrán ser revisados independientemente. – Fácil inclusión de referencias a otra información como archivos, URL, figuras, etc. – Generación simple de otros formatos para su visualización como PDF y HTML. – Como se trabaja con XML, los ficheros son independientes del editor utilizado. – Permitirá obtener documentación incluida en el código fuente de las aplicaciones e incluirla de forma automática en la mayor parte de situaciones. 46

Administracion_redes_GNULinux  
Advertisement