2
7/23/2019 Estructura Del Documento MANUAL TÉCNICO http://slidepdf.com/reader/full/estructura-del-documento-manual-tecnico 1/2 Estructura del documento MANUAL TÉCNICO 1. Índice Relación de los captulos ! p"#inas correspondientes $ue %orman parte del documento &. Introducción. 'e de(e presentar una (re)e descripción del sistema desarrollado* $ue contemple el "m(ito a(arcado* cual es su %unción principal ! un detalle de las %unciones macros o partes $ue lo componen. +uede incluir un mensa,e de la m"-ima autoridad de las "reas comprendidas en el manual. &.1. O(,eti)o #eneral del sistema 'e de(e de descri(ir el o(,eti)o #eneral del sistema. &.&. O(,eti)os especcos 'e de(en descri(ir (re)emente los o(,eti)os especcos $ue se cumplieron con el desarrollo del sistema. /. Contenido t0cnico /.1. enición de re#las del ne#ocio implementadas en el sistema desarrollado. /.&. ia#ramas de 2u,o de datos* ,unto con su respecti)o diccionario de datos. /./. Controles de auditoria implementados en el sistema. /.3. escripción de campos re$ueridos por pantalla con presentación de pantallas. /.4. ia#rama de na)e#ación del sistema. /.5. Re$uerimientos de inter%ase con otros sistemas. /.6. Modelo ló#ico de datos* dia#rama entidad7relación. /.8. Modelo de datos %sico* ,unto con su respecti)o diccionario de datos. /.9. Matri: de procesos )ersus or#ani:ación. /.1;. Matri: de pro#ramas )ersus entidades. /.11. +lata%orma de usuario. A$u se descri(en los re$uerimientos mnimos $ue se de(en tener tanto de <ard=are como de so%t=are para $ue el sistema se pueda instalar ! e,ecutar correctamente >en caso de $ue se considere necesario?. /.1&. @reas de aplicación !o alcance de los procedimientos. Es%era de acción $ue cu(ren los procedimientos 3. Responsa(les. +ara iniciar los tra(a,os $ue conducen a la inte#ración de un manual* es indispensa(le pre)er $ue no $ueda diluida la responsa(ilidad de la conducción de las acciones en di)ersas personas* sino $ue de(e desi#narse a un coordinador* au-iliado por un e$uipo t0cnico* al $ue se le de(e encomendar la conducción del pro!ecto en sus %ases de diseBo* implantación ! actuali:ación. e esta manera se lo#ra <omo#eneidad en el contenido ! presentación de la in%ormación. +or lo $ue respecta a las caractersticas del e$uipo t0cnico* es con)eniente $ue sea personal con un (uen mane,o de las relaciones <umanas ! $ue cono:ca a la or#ani:ación en lo $ue concierne a sus o(,eti)os* estructura* %unciones ! personal. +ara este tipo de tra(a,o* una or#ani:ación puede nom(rar a la persona $ue ten#a los conocimientos ! la e-periencia necesarios para lle)arlo a ca(o. +or la naturale:a de sus %unciones puede encar#arlo al titular de el "rea especca. Asimismo* puede contratar los ser)icios de consultores e-ternos.

Estructura Del Documento MANUAL TÉCNICO

Embed Size (px)

Citation preview

Page 1: Estructura Del Documento MANUAL TÉCNICO

7/23/2019 Estructura Del Documento MANUAL TÉCNICO

http://slidepdf.com/reader/full/estructura-del-documento-manual-tecnico 1/2

Estructura del documento MANUAL TÉCNICO

1. Índice

Relación de los captulos ! p"#inas correspondientes $ue %orman parte del documento

&. Introducción.

'e de(e presentar una (re)e descripción del sistema desarrollado* $ue contemple el "m(ito

a(arcado* cual es su %unción principal ! un detalle de las %unciones macros o partes $ue locomponen. +uede incluir un mensa,e de la m"-ima autoridad de las "reas comprendidas en elmanual.

&.1. O(,eti)o #eneral del sistema

'e de(e de descri(ir el o(,eti)o #eneral del sistema.

&.&. O(,eti)os especcos

'e de(en descri(ir (re)emente los o(,eti)os especcos $ue se cumplieron con el desarrollodel sistema.

/. Contenido t0cnico/.1. enición de re#las del ne#ocio implementadas en el sistema desarrollado.

/.&. ia#ramas de 2u,o de datos* ,unto con su respecti)o diccionario de datos.

/./. Controles de auditoria implementados en el sistema.

/.3. escripción de campos re$ueridos por pantalla con presentación de pantallas.

/.4. ia#rama de na)e#ación del sistema.

/.5. Re$uerimientos de inter%ase con otros sistemas.

/.6. Modelo ló#ico de datos* dia#rama entidad7relación./.8. Modelo de datos %sico* ,unto con su respecti)o diccionario de datos.

/.9. Matri: de procesos )ersus or#ani:ación.

/.1;. Matri: de pro#ramas )ersus entidades.

/.11. +lata%orma de usuario. A$u se descri(en los re$uerimientos mnimos $ue se de(entener tanto de <ard=are como de so%t=are para $ue el sistema se pueda instalar ! e,ecutarcorrectamente >en caso de $ue se considere necesario?.

/.1&. @reas de aplicación !o alcance de los procedimientos. Es%era de acción $ue cu(ren los

procedimientos3. Responsa(les.

+ara iniciar los tra(a,os $ue conducen a la inte#ración de un manual* es indispensa(le pre)er$ue no $ueda diluida la responsa(ilidad de la conducción de las acciones en di)ersaspersonas* sino $ue de(e desi#narse a un coordinador* au-iliado por un e$uipo t0cnico* al $uese le de(e encomendar la conducción del pro!ecto en sus %ases de diseBo* implantación !actuali:ación. e esta manera se lo#ra <omo#eneidad en el contenido ! presentación de lain%ormación. +or lo $ue respecta a las caractersticas del e$uipo t0cnico* es con)eniente $uesea personal con un (uen mane,o de las relaciones <umanas ! $ue cono:ca a la or#ani:aciónen lo $ue concierne a sus o(,eti)os* estructura* %unciones ! personal. +ara este tipo de

tra(a,o* una or#ani:ación puede nom(rar a la persona $ue ten#a los conocimientos ! lae-periencia necesarios para lle)arlo a ca(o. +or la naturale:a de sus %unciones puedeencar#arlo al titular de el "rea especca. Asimismo* puede contratar los ser)icios deconsultores e-ternos.

Page 2: Estructura Del Documento MANUAL TÉCNICO

7/23/2019 Estructura Del Documento MANUAL TÉCNICO

http://slidepdf.com/reader/full/estructura-del-documento-manual-tecnico 2/2

3.1. Mapa de na)e#ación. muestra de %orma #r"ca la intercone-ión entre cada una de laspantallas del sistema* lo $ue ser)ira para sa(er como lle#ar a determinada parte de laaplicación. En este se muestran los mens* su(mens ! pantallas a las $ue nos lle)a cadauno de ellos

3.&. escripción #r"ca del mapa de na)e#ación. En el anterior aparece de %orma dedia#rama de 2u,o ! en esta sección de(er" aparecer !a con las respecti)as pantallas.

3./. escri(e paso a paso los procesos* as como pantallas* (otones* cuadros de te-to* etc.*pero tam(i0n se muestra el códi#o de cada rutina* pantalla* (otón* etc. es decir* se muestra lo$ue <a! detr"s de la inter%a: del usuario