Issuu on Google+

HELVISON TOMOCHE CI:24220032


1


Esta documentación tiene como objeto hacer más comprensible el código fuente a otros programadores que tengan que trabajar con él, ya sea porque forman parte del grupo de desarrollo, el programa va a ser mantenido o modificado por otra persona distinta al programador inicial. También resulta muy útil durante la depuración y el mantenimiento del programa por el propio programador, al paso del tiempo las decisiones se olvidan y surgen dudas hasta en el propio programador de porqué se hicieron las cosas de una determinada manera y no de otra. Por motivos laborales como un proyecto muy grande con muchos objetos ubicados en distintos directorios, uno se ve en la necesidad de documentar grandes cantidades de código. Además, sumado al hecho de que es muy probable que se agreguen más programadores, la necesidad de tener una documentación del código se torna realmente necesaria para que puedan ponerse al día rápidamente.

2


Significa que los símbolos convencionales se usan en todos los diagramas de flujo para prescribir el sistema y que en la documentación se usen formas estandarizadas. Aún cuando las normas de documentación varían de una instalación a otra, es esencial que dentro de una organización, se utilice un solo método. El uso de procedimientos y documentación estandarizada proporciona la base de una comunicación clara y rápida, adiestramiento menos costoso del personal de sistemas, reducción de costos de almacenamiento, y otros.

4


5


Sirve como punto de partida al Sistema propuesto, ya que será función de la gerencia, de acuerdo con los usuarios de dicho Sistema, determinar si lo expuesto en él satisface los requerimientos del propio sistema. Una vez lograda la aprobación, se estará en condiciones de iniciar el desarrollo del Sistema propuesto e ir integrando el resto de la documentación. El manual tiene como finalidad el permitir a la alta gerencia tener la información necesaria y suficiente sobre un sistema en particular y servir como fuente dc consulta una vez que el Sistema ha sido implantado. -Contenido -Nombre del sistema -Describir el nombre del sistema a implantar en la empresa. -Equipo Encargado Del Sistema -Nombre del personal encargado del análisis y diseño del sistema

6


 

 

 

-Resumen Administrativo Compendio de los puntos que se describen en el manual, el cual tiene como propósito permitir a los altos ejecutivos enterarse en forma somera de la propuesta del sistema. En este punto aparece por primera vez el nombre del sistema, el cual debe ser único, este deberá conservarse invariable en todos los documentos referentes a ese sistema. Planteamiento Este punto tiene como finalidad registrar los antecedentes que servirán de partida al desarrollo del análisis del sistema. Se debe mencionar: -Dependencia que requirió el trabajo. -Personas y / o puestos ocupados por estas al momento de requerirse el trabajo (acuerdos, disposiciones legales, memorandos, y otros) -Condiciones y criterios que normaron el desarrollo del trabajo.

 

Aquí se dejarán establecidos los objetivos que debe cubrir el sistema, en forma clara y precisa para evitar errores de interpretación. Entradas Del Sistema (Información A Captar) Debe quedar especificado en este punto, los documentos fuentes que inician las operaciones del sistema así como la información detallada de aquellos conceptos que serán los datos a captar por el sistema. Se deberán mencionar todos los datos que en forma secundaria originan una entrada importante

-Fechas correspondientes.

7


Diagramación General Del Sistema Es la representación gráfica de las fases del Sistema y su flujo a través de las dependencias que intervienen en el mismo, aunque en forma generalizada. La técnica a utilizar y la simbología debe ser seleccionada por los interesados. Explicaciones De Las Fases Del Sistema Este punto se encuentra relacionado con el anterior ya que lo que se muestra gráficamente, ahora se describe en forma genérica, explicando los procesos que se llevan a cabo en cada dependencia sin profundizar en detalles técnicos o específicos. Se deberá resaltar aquellas fases del proceso en las cuáles se obtengan resultados de importancia así como aquellas que requieran una supervisión especial. 8


9


 

 

 

Requerimientos Del Sistema -Se establecen los recursos, tanto humanos como materiales que son necesarios para poder llevar a cabo el sistema. Presentar costos y descripción, además de las cantidades que se requieran. -Estimación De La Fecha Probable De Implementación Del Sistema -Es necesario que exista una fecha probable de implantación cuya base será la terminación de todas las actividades para la creación del sistema, tales como: análisis, programación, elaboración de formas, y otros. -Se recomienda utilizar diagrama de Grantt o de Pert para establecer el período de las actividades requeridas para el desarrollo del sistema. Manuales Del usuario Expone los procesos que el usuario puede realizar con el sistema implantado. Para lograr esto, es necesario que se detallen todas y cada una de las características que tienen los programas y la forma de acceder e introducir información. Permite a los usuarios conocer el detalle de qué actividades ellos deberán desarrollar para la consecución de los objetivos del sistema. Reúne la información, normas y documentación necesaria para que el usuario conozca y utilice adecuadamente la aplicación desarrollada.

10


11


12


Diagrama general del sistema

13


14


 

 

Manual de captación Permite tener una clara visión del proceso de Captación de los latos fuentes previo al procesamiento electrónico de los mismos. Objetivos Documentar al usuario a cerca del recorrido a través de las pantallas del sistema. Conocer la forma cómo el usuario puede utilizar el equipo necesario para la ejecución del sistema. 15


Este diagrama debe ser presentado gráficamente y en forma sencilla. Representar los diagramas utilizando para ello diagramas de bloques (es el mismo diagrama que se presenta en el Manual Administrativo). Diagramas De Pantalla Presentar en este punto el flujo del sistema en las pantallas utilizadas por cada módulo. Puntos a documentar en una pantalla: -Explicación del recorrido para llegar a la pantalla. -Formato de los datos a captar. -Formato en que son captados los datos. -Explicación Genérica De Las Fases Del Sistema -Es una explicación clara, breve de todos los módulos que se presentan en el diagrama general. -Equipo Utilizado Para La Captación -Se debe crear un instructivo que permita al usuario el entrenamiento del sistema.

Uso del equipo:

Describir detalladamente el uso correcto del equipo utilizado para la captación de la información, dando una explicación del encendido, manejo, control y del material que se usa como medio de captación de los datos. 16


17


visun i onioche

1,)


Documentacion de codigo