contenido de manual tecnico de software

. ELABORACION DEL MANUAL TECNICO
Este documento contiene toda la información sobre l
os recursos
utilizados por el proyecto, llevan una descripción
muy bien detallada sobre las
característicasfísicas y técnicas de cada elemento
. Por ejemplo: características
de procesadores, velocidad, dimensiones del equipo,
garantías, soporte,
proveedores y equipo adicional.
Su extensión depende dela cantidad de recursos y e
quipo utilizado y
generalmente se presenta en forma de fichas técnica
s en donde se describe en
cada una las características de cada recurso.
Consideracionesgenerales para la documentación del
desarrollo de
aplicaciones informáticas:
Toda documentación que se genere para un proyecto e
specífico, que
haya sido revisada y aprobada, debe poseer lo siguiente:
• Identificación del documento
Este documento debe incorporar la siguiente informa
ción:
• Logotipo de la organización.
• Nombre oficial de la organización
• Denominación y extensión. Decorresponder a una u
nidad en particular debe
anotarse el nombre de la misma.
• Lugar y fecha de elaboración.
• Número de revisión (en su caso).
• Unidades responsables de su elaboración, revisióny/o autorización.
• Clave de la forma. En primer término, las siglas
de la organización, en
segundo lugar las siglas de la unidad administrativ
a donde se utiliza la forma y,
por último, elnúmero de la forma. Entre las siglas
y el número debe colocarse
un guión o diagonal. (En su caso).
Estructura del documento.
Por cada documento final deberá entregarse copias
al personal
involucradoen el proyecto.
Una vez concluido el desarrollo de un sistema, cons
iderando para esto
los posibles cambios que se efectúen durante la eta
pa de garantía de que lo
cubre (si así fuera el caso),el usuario final del
sistema debe recibir una versión
actualizada final del documento manual técnico.
Estructura del documento manual técnico
• Índice
Relación de los capítulos y páginas...