Osd En Mexico

5.6 Estándares de documentación
Una buena documentación es esencial para lograr un diseño correcto y un mantenimiento eficiente de los sistemas digitales. Además de ser precisa y completa, ladocumentación debe ser algo instructiva, de modo que un ingeniero de pruebas, técnico de mantenimiento, o inclusive el ingeniero de diseño original, pueda averiguar cómo funciona el sistema con solo leer ladocumentación.
Importancia de los documentos estandarizados
– documentos: única forma tangible de representar el software y el proceso del software
– documentos estandarizados: apariencia,estructura y calidad consistentes; más fáciles de leer y comprender
Tipos de estándares
Estándares del proceso de documentación:
• Proceso a seguir para la producción del documento
• Documentos detrabajo: no es necesario aplicar procesos formales de calidad
• Documentos formales (para desarrollos posteriores o a entregar al cliente): necesario adoptar un proceso formal de calidad
Estándares deldocumento:
• Estructura y presentación de los documentos
• deben tener un estilo y apariencia consistente, y los del mismo tipo deben tener una estructura consistente con los del proyecto y laorganización
Estándares para el intercambio de documentos:
• aseguran que todas las copias electrónicas de los documentos sean compatibles
• Utilización de herramientas concretas para elaborar losdocumentos (hojas de cálculo, procesadores de texto, herramientas de diagramación,...)
Estándares de identificación de documentos: cada documento debe identificarse de forma única
– documentos formales:identificador formal definido por el administrador de la configuración
– documentos informales: identificador definido por el administrador del proyecto
Estándares de la estructura del documento:secciones, numeración de páginas, encabezados, información de pies de página, numeración de secciones,...
Estándares de presentación de documentos: tipos de letra y estilos, logotipos y nombres de...