documentacion de codigo

18
HELVISON TOMOCHE CI:24220032

Upload: helvison-tomoche-tomoche

Post on 21-Feb-2016

222 views

Category:

Documents


0 download

DESCRIPTION

trabajo de tecnica de programacion

TRANSCRIPT

HELVISON TOMOCHECI:24220032

1

Esta documentación tiene comoobjeto hacer más comprensible elcódigo fuente a otros programadoresque tengan que trabajar con él, yasea porque forman parte del grupode desarrollo, el programa va a sermantenido o modificado por otrapersona distinta al programadorinicial. También resulta muy útildurante la depuración y elmantenimiento del programa por elpropio programador, al paso deltiempo las decisiones se olvidan ysurgen dudas hasta en el propioprogramador de porqué se hicieronlas cosas de una determinada maneray no de otra. Por motivos laboralescomo un proyecto muy grande concomo un proyecto muy grande conmuchos objetos ubicados endistintos directorios, uno se ve en lanecesidad de documentar grandescantidades de código. Además,sumado al hecho de que es muyprobable que se agreguen másprogramadores, la necesidad detener una documentación del códigose torna realmente necesaria paraque puedan ponerse al díarápidamente.

2

Significa que los símbolosconvencionales se usan en todos losdiagramas de flujo para prescribir elsistema y que en la documentación seusen formas estandarizadas.

Aún cuando las normas dedocumentación varían de unainstalación a otra, es esencial quedentro de una organización, se utiliceun solo método. El uso deprocedimientos y documentaciónprocedimientos y documentaciónestandarizada proporciona la base deuna comunicación clara y rápida,adiestramiento menos costoso delpersonal de sistemas, reducción decostos de almacenamiento, y otros.

4

5

Sirve como punto de partida al Sistemapropuesto, ya que será función de la gerencia,de acuerdo con los usuarios de dicho Sistema,determinar si lo expuesto en él satisface losrequerimientos del propio sistema. Una vezlograda la aprobación, se estará en condicionesde iniciar el desarrollo del Sistema propuesto eir integrando el resto de la documentación.El manual tiene como finalidad el permitir a laalta gerencia tener la información necesaria yalta gerencia tener la información necesaria ysuficiente sobre un sistema en particular y servircomo fuente dc consulta una vez que el Sistemaha sido implantado.-Contenido-Nombre del sistema-Describir el nombre del sistema a implantar enla empresa.-Equipo Encargado Del Sistema-Nombre del personal encargado del análisis ydiseño del sistema

6

-Resumen Administrativo Compendio de los puntos que se

describen en el manual, el cual tiene comopropósito permitir a los altos ejecutivosenterarse en forma somera de lapropuesta del sistema. En este puntoaparece por primera vez el nombre delsistema, el cual debe ser único, estedeberá conservarse invariable en todos losdocumentos referentes a ese sistema.

Planteamiento Este punto tiene como finalidad registrar

los antecedentes que servirán de partidaal desarrollo del análisis del sistema. Sedebe mencionar:

Aquí se dejarán establecidos losobjetivos que debe cubrir elsistema, en forma clara y precisapara evitar errores deinterpretación.

Entradas Del Sistema (InformaciónA Captar)

Debe quedar especificado en estepunto, los documentos fuentesque inician las operaciones delsistema así como la informacióndebe mencionar:

-Dependencia que requirió el trabajo.

-Personas y / o puestos ocupados porestas al momento de requerirse el trabajo(acuerdos, disposiciones legales,memorandos, y otros)

-Condiciones y criterios que normaron eldesarrollo del trabajo.

-Fechas correspondientes.

sistema así como la informacióndetallada de aquellos conceptosque serán los datos a captar porel sistema. Se deberán mencionartodos los datos que en formasecundaria originan una entradaimportante

7

Diagramación General Del SistemaEs la representación gráfica de las fases del Sistema ysu flujo a través de las dependencias que intervienen enel mismo, aunque en forma generalizada. La técnica autilizar y la simbología debe ser seleccionada por losinteresados.

Explicaciones De Las Fases Del SistemaEste punto se encuentra relacionado con el anterior yaEste punto se encuentra relacionado con el anterior yaque lo que se muestra gráficamente, ahora se describeen forma genérica, explicando los procesos que sellevan a cabo en cada dependencia sin profundizar endetalles técnicos o específicos. Se deberá resaltaraquellas fases del proceso en las cuáles se obtenganresultados de importancia así como aquellas querequieran una supervisión especial.

8

9

Requerimientos Del Sistema

-Se establecen los recursos, tanto humanos comomateriales que son necesarios para poder llevar acabo el sistema. Presentar costos y descripción,además de las cantidades que se requieran.

-Estimación De La Fecha Probable De ImplementaciónDel Sistema

-Es necesario que exista una fecha probable deimplantación cuya base será la terminación de todaslas actividades para la creación del sistema, talescomo: análisis, programación, elaboración de formas,y otros.

-Se recomienda utilizar diagrama de Grantt o de Pert -Se recomienda utilizar diagrama de Grantt o de Pertpara establecer el período de las actividadesrequeridas para el desarrollo del sistema.

Manuales Del usuario

Expone los procesos que el usuario puede realizarcon el sistema implantado. Para lograr esto, esnecesario que se detallen todas y cada una de lascaracterísticas que tienen los programas y la formade acceder e introducir información. Permite a losusuarios conocer el detalle de qué actividades ellosdeberán desarrollar para la consecución de losobjetivos del sistema. Reúne la información, normas ydocumentación necesaria para que el usuario conozcay 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 deCaptación de los latosfuentes previo alprocesamiento electrónicoprocesamiento electrónicode los mismos.

Objetivos Documentar al usuario a

cerca del recorrido através de las pantallas delsistema. Conocer la formacómo el usuario puedeutilizar el equiponecesario para laejecución del sistema.

15

Este diagrama debe ser presentado gráficamente yen forma sencilla. Representar los diagramasutilizando para ello diagramas de bloques (es elmismo diagrama que se presenta en el ManualAdministrativo).Diagramas De PantallaPresentar en este punto el flujo del sistema en laspantallas utilizadas por cada módulo.

Puntos a documentar en una pantalla:-Explicación del recorrido para llegar a lapantalla.-Formato de los datos a captar.-Formato en que son captados los datos.-Explicación Genérica De Las Fases DelSistema-Es una explicación clara, breve de todos losmódulos que se presentan en el diagrama -general.-Equipo Utilizado Para La Captación-Se debe crear un instructivo que permita alusuario el entrenamiento del sistema.

Uso del equipo:

Describir detalladamente eluso correcto del equipoutilizado para la captación dela información, dando unaexplicación del encendido,manejo, control y del materialque se usa como medio decaptación de los datos.

16

17

1,)

visun i onioche