Manual de Documentación

Nelson Alejandro Meza Rojas Manual de Documentacin
07/01/2012
ndice
1. 2. 3. 3.1 3.2 3.3 3.4 3.5 3.6 3.7 4. 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 5. 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 6. 6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 7. 7.1 8. 9. 9.1
07/01/2012
LOS OBJETIVOS. ..........................................................................................................................................3 LA UTILIZACIN. ........................................................................................................................................4 DOCUMENTACIN DE DISEO.............................................................................................................5 DESCRIPCIN DE LAS FUNCIONES DEL SISTEMA ....................................................................................................5 DIAGRAMA DE FLUJO DE INFORMACIN DEL SISTEMA ............................................................................................5 DIAGRAMA DE LA ESTRUCTURA DEL SISTEMA ........................................................................................................5 INFORMES DEL SISTEMA .......................................................................................................................................5 ARCHIVOS DEL SISTEMA .......................................................................................................................................6 ENTRADAS DEL SISTEMA ......................................................................................................................................7 ESPECIFICACIONES DE PROGRAMACIN ................................................................................................................7 DOCUMENTACIN DE PROGRAMACIN .............................................................................................8 NDICE DE LOS PROGRAMAS DEL MANUAL .............................................................................................................8 DESCRIPCIN GENERAL:.......................................................................................................................................8 DIAGRAMA DE ENTRADAS Y SALIDAS ....................................................................................................................8 ARCHIVOS DE ENTRADA Y SALIDA.........................................................................................................................8 INFORMES PRODUCIDOS.......................................................................................................................................9 DIAGRAMA ESTRUCTURADO DEL PROGRAMA .........................................................................................................9 LISTADO DEL MDULO FUENTE ............................................................................................................................9 MENSAJES Y PARMETROS DE CONTROL ...............................................................................................................9 DOCUMENTACIN DE OPERACIN.....................................................................................................10 DESCRIPCIN DE LAS FUNCIONES DEL SISTEMA ..................................................................................................10 DIAGRAMA DE ESTRUCTURA E INTERRELACIONES DE LOS JOBS ..........................................................................10 NDICE DE LOS JOBS DEL MANUAL .....................................................................................................................10 DESCRIPCIN DEL JOB (PARA CADA JOB)..........................................................................................................10 DIAGRAMA DE LA ESTRUCTURA DEL JOB ............................................................................................................11 DESCRIPCIN DE LOS ARCHIVOS ........................................................................................................................11 MENSAJES Y PARMETROS DE CONTROL .............................................................................................................11 FORMULARIOS DE ENTRADA DE TRASCRIPCIN ...................................................................................................11 INFORMES QUE PRODUCE ...................................................................................................................................12 LISTADO DE LAS TARJETAS DEL LENGUAJE DE CONTROL ..................................................................................12 DOCUMENTACIN DEL USUARIO........................................................................................................13 OBJETIVO DEL MANUAL ......................................................................................................................................13 POLTICAS Y NORMAS ........................................................................................................................................13 RESPONSABILIDADES..........................................................................................................................................13 OBJETIVOS DEL SISTEMA....................................................................................................................................13 DIAGRAMA DE FLUJO DE LA INFORMACIN ..........................................................................................................13 PROCEDIMIENTOS ..............................................................................................................................................13 FORMULARIOS, VENTANAS, INSTRUCTIVOS Y DIAGRAMA DE FLUJOS ....................................................................14 INFORMES .........................................................................................................................................................15 RESPONSABILIDADES..........................................................................................................................................15 TIPS SOBRE PROGRAMACIN..............................................................................................................16 DOCUMENTACIN DE MTODOS Y PROGRAMAS ...................................................................................................18 DIAGRAMACIN ESTRUCTURADA. .....................................................................................................20 CODIFICACIN DE LOS NOMBRES DE LOS ARCHIVOS. ..............................................................23 DE ARCHIVOS DE O Y M WSSTCCC. ...................................................................................................................23
-1-
ndice
9.2 9.3 9.4 9.5 9.6 9.7 9.8 9.9
07/01/2012
DE PROYECTOS PSSACCC...................................................................................................................................23 DE LIBRERAS LSSACCC. ....................................................................................................................................23 DE PROGRAMAS FUENTES, MDULOS, RUTINAS ASSFCCCT. .................................................................................23 DE FORMAS (VENTANAS) FSSACCCTNN..............................................................................................................24 DE REPORTES RSSACCCSNN. .............................................................................................................................24 JOBS JSSFCCCT: .............................................................................................................................................24 DE DATOS FSSCCCCRNN. ...................................................................................................................................25 CONVENCIONES PARA LOS NOMBRES DE LOS OBJETOS Y CONTROLES....................................................................26
-2-
Objetivos
1. Los objetivos.
07/01/2012
El desarrollar un sistema IT se caracteriza por una cooperacin entre personas, utilizando computadoras para alcanzar un fin. Cuando ya existe la aplicacin, comienza el proceso de mantenimiento del mismo, en esta fase es importante que las personas que mantengan la aplicacin, fcilmente lo entiendan y as puedan efectuar sus tareas con mayor seguridad y rapidez. En la actualidad existen varios productos comunes para toda el rea de informtica, como lo son los manejadores de base de datos, monitores de teleproceso, procesadores de palabra, hojas de calculo, y procedimientos catalogados, los cuales requieren de cierta uniformidad de trabajo y en algunos casos grupos especiales para administrarlos. La naturaleza del rea de trabajo que significa informtica, se caracteriza sobre todo de muchos detalles, lo cual implica la cooperacin. Todo lo mencionado se refiere a un fin comn: ! Hay que trabajar con ciertas normas y procedimientos manuales. ! El propsito principal de este manual es el de dotar al personal de la gerencia de una gua de normas para la implantacin de sistemas y aplicaciones. Estas cubren la codificacin y documentacin, siguiendo disciplinas y metodologas. Para que funcione eficientemente esa rea de la organizacin, es necesario que cada uno cumpla con las normas e instrucciones de este manual, recordando que una buena documentacin conduce a: . Proporcionar la informacin necesaria para la revisin y entendimiento de las entidades que conforman las aplicaciones que se han desarrollado, con plena independencia de las personas que los disearon e instalaron. . Simplificar las tareas de depuracin de las aplicaciones, proporcionando el detalle completo de los propsitos y alcances de la aplicacin. . Lograr que la productividad aumente; El mantenimiento de las aplicaciones existentes se pueda realizar de manera ms simple y rpida. . Hacer ms sencillo y productivo el entrenamiento de personal nuevo sobre la base de normas de codificacin y documentacin. Si hay partes del manual no muy explicitas, es importante aclarar realmente la intencin de stas, esto significa que hay que preguntar a otras personas y discutir al respecto con ellas.
-3-
Objetivos
07/01/2012
2. La utilizacin. Junto con los manuales de los proveedores de las herramientas, aspiramos que este manual contenga la informacin que bsicamente necesita el personal IT para resolver sus problemas, tambin ser til para los analistas de sistemas, porque contiene tanto normas sobre estructuras de nombres como de documentacin de programas, etc. Cada persona que tenga una copia de este manual, ser responsable de ella. Esto implica que la actualizar y mantendr al da, usando la informacin que automticamente recibir cuando exista alguna modificacin. Para disminuir el volumen del manual tanto abreviaturas de palabras usadas frecuentemente. Abreviatura Significado CPU Central Processing Unit. DB Data Base. BD Base de Datos. DBA Data Base Administrator. DDL Data Definition Language. DML Data Manipulation Language. DCL Data Control Language. como para facilitar su creacin, existen varias Abreviatura DBS DMS E/S IT FMS SQL DBMS Significado Data Base System. Data Management System. Entrada / salida Information technology. File Management System. Structure Query Language Data Base Management System.
-4-
Documentacin de Diseo
3. DOCUMENTACIN DE DISEO
07/01/2012
El objetivo del manual de documentacin de diseo es presentar parte de la documentacin de la etapa de diseo detallado y programacin. En el se incluirn las especificaciones generales del diseo del sistema, con el fin de que pueda realizarse eficientemente su programacin e implantacin, seguidamente se explican cada una de las secciones que lo componen. 3.1 Descripcin de las Funciones del Sistema En esta seccin se describirn detalladamente las funciones principales del sistema, indicndose los elementos involucrados en cada una de ellas, los alcances de cada funcin y las fronteras existentes con relacin a los sistemas actuales o futuros. 3.2 Diagrama de flujo de Informacin del Sistema Se incluir un diagrama de flujo que indique el flujo de la informacin a travs de los distintos departamentos, desde el origen de la informacin hasta su destino. Este mostrar: datos de entrada, operaciones ejecutadas, decisiones, acciones tomadas e informes producidos. 3.3 Diagrama de la Estructura del Sistema Mediante este diagrama se muestra la estructura del sistema, considerando: los principales elementos del sistema de procesamiento de datos (programas, datos de entrada, archivos e informes producidos), y las relaciones existentes entre ellos. 3.4 Informes del Sistema En esta seccin se describen en detalle todos los informes del sistema. subsecciones consideradas son: 3.4.1 Distribucin y volumen de los informes Se indicarn para todos los informes del sistema: a) Cdigo del informe b) Nombre del informe c) Aproximado de pginas d) Fecha de preparacin o frecuencia. 3.4.2 Formato de los informes Se incluye un modelo del diseo (Spacing Chart) por cada informe del sistema, su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin. Las
-5-
3.4.3 Descripcin de los informes
07/01/2012
Es una narrativa que describe en el lenguaje del usuario, la forma como debe leerse, interpretarse y utilizarse la informacin contenida en cada uno de los informes del sistema. 3.5 Archivos del Sistema Es una descripcin detallada del contenido y organizacin de los archivos del sistema. Esta informacin descriptiva es esencial como medio de comunicacin entre el analista y el programador. En esta seccin se incluye: 3.5.1 Descripcin de los archivos Se describen las caractersticas funcionales, fsicas y tcnicas de cada archivo del sistema y el diseo de registro de cada archivo, para los efectos se utilizar el formulario de documentacin de archivos descrito en el manual de codificacin de archivos y mensajes, indicando: a) Nombre del archivo (Lgico) b) Descripcin del contenido c) Frecuencia de actualizacin d) Tipo de archivo (maestro, transacciones, trabajo, etc.) e) Tiempo de retencin de la informacin f) Ciclos de retencin del archivo g) Tipo de registro (fijo o variable) h) Longitud mxima del registro i) Procedimiento de recuperacin del archivo en caso de catstrofe j) Volumen estimado. (Registros) k) Organizacin Cdigo y Nombre de la etiqueta del archivo (Fsico), su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin.
-6-
07/01/2012
3.6 Entradas del Sistema En sta seccin se describe toda la documentacin de las entradas del sistema (Formularios y Ventanas), la cual debe contener: 3.6.1 Descripcin de las entradas a) Cdigo de la entrada b) Propsito c) Volumen estimado (para Formularios) d) Origen de la entrada e) Archivos que actualiza o crea 3.6.2 Diseo de los formularios Se anexaran todos los diseos de formularios que contengan informacin de entrada al sistema. 3.7 Especificaciones de Programacin Define las funciones y los mtodos de operacin de los programas del sistema. Esta informacin debe ser organizada y presentada de manera que sea fcilmente usada por los programadores. Se preparan especificaciones de programacin para cada programa del sistema, los cuales contendrn: 3.7.1 Diagrama de entradas y salidas del programa Se prepara un diagrama que identifican las ventanas, los archivos de entrada y salida que procesa y los informes que produce el programa. 3.7.2 Descripcin del programa Es una narrativa que describe brevemente, las entradas del programa, las salidas del programa y las funciones principales del programa
3.7.3 Lgica del proceso Mediante una narrativa se explica el modo como deber procesarse la informacin dentro del programa. En esta seccin podra incluirse: diagrama de flujo Se incluye el diagrama del flujo de programa o Pseudo-cdigo, tablas de decisin o cualquier otra informacin que facilite la explicacin del proceso del programa.
-7-
Documentacin de Programacin
4. DOCUMENTACIN DE PROGRAMACIN
07/01/2012
El objetivo del manual de documentacin de programacin es presentar la documentacin de todos los programas que componen el sistema. En este manual deber incluirse los listados de los programas, la informacin sobre el diseo de los mismos (Pseudo Cdigo o Diagrama Estructurado) y el resultado de las pruebas, seguidamente se describe el contenido de cada una de las secciones que lo componen. 4.1 ndice de los programas del Manual En esta seccin se prepara un ndice de los programas que se incluye. 4.2 Descripcin general: Se describe en forma general el programa, Indicndose: 4.2.1 Cdigo y nombre del programa Es el cdigo-nombre del programa, su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin. 4.2.2 Objetivos del programa Se indica brevemente los objetivos del programa, sealando los archivos que actualiza, crea, valida, clasifica, etc. y los informes que produce. 4.2.3 Funciones principales Se describen las funciones principales del programa 4.3 Diagrama de Entradas y Salidas Es un diagrama que muestra los parmetros, archivos de entrada, informes y archivos de salida del programa. 4.4 Archivos de Entrada y Salida En esta seccin se describen los archivos que procesa el Programa. Esta documentacin se encuentra en la seccin del Manual de Diseo, y de esta deber seleccionarse los archivos que intervienen en cada programa.
-8-
Documentacin de Programacin
07/01/2012
4.5 Informes Producidos Es una muestra del diseo (Spacing Chart) por cada informe que genera el programa. 4.6 Diagrama Estructurado del Programa Se incluye el diagrama estructurado de programa o Pseudo-cdigo mostrndose, mediante los smbolos apropiados y en su secuencia lgica, las operaciones que ejecuta el programa. 4.7 Listado del Mdulo Fuente En esta seccin se anexa un listado actualizado del cdigo fuente del programa. 4.8 Mensajes y Parmetros de Control Se documentan todos los mensajes que produce el programa, indicndose: su significado y la accin a tomar, su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin. As mismo, se incluyen todos los parmetros de control y su efecto sobre el programa.
-9-
Documentacin de Operacin
5. DOCUMENTACIN DE OPERACIN
07/01/2012
El objetivo del manual de documentacin de operacin es presentar la documentacin de todos los "JOBS" del sistema. Este manual contender informacin destinada a facilitar el procesamiento de los datos a travs del computador y el control de calidad de la informacin de salida, seguidamente se describe el contenido de cada una de las secciones que lo componen. 5.1 Descripcin de las Funciones del Sistema En esta seccin se describirn detalladamente las funciones principales del sistema, haciendo referencia a los diferentes JOBS que lo componen, estableciendo los alcances de cada funcin y las fronteras existentes con relacin a los sistemas actuales o futuros. 5.2 Diagrama de Estructura e Interrelaciones de los JOBS Es un diagrama que muestra la estructura del sistema en el mbito de los "JOBS" que lo componen, en l deber mostrarse los principales elementos de cada "JOB" y la relacin de stos en todo el sistema. 5.3 ndice de los JOBS del Manual En esta seccin se prepara un ndice de los "JOBS". 5.4 Descripcin del JOB (para cada JOB) Se describe en forma general el "JOB". Indicndose: 5.4.1 Nombre del Job Cdigo-Nombre del JOB, su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin.
5.4.2 Funciones principales Se indican cada una de las funciones principales del "JOB" 5.4.3 Frecuencia Es la frecuencia de procesamiento del "JOB" (semanal, diaria, etc.)
- 10 -
07/01/2012
5.4.4 Interrelaciones con otros "JOB" Se indican los "JOBS" que debern ser procesados antes y despus de ste, dependiendo de la causa del procesamiento. 5.4.5 Archivos que procesa Se indican los nombres de los volmenes o carpetas de los archivos que utiliza el "JOB". 5.4.6 Instrucciones de Operacin Mediante una narrativa se indican las instrucciones de operacin del JOB relacionado con el procesamiento de datos a travs del computador.
5.5 Diagrama de la Estructura del JOB Mediante un diagrama se muestra la estructura del "JOB", considerando los principales elementos de procesamiento de datos que componen el "JOB" y mostrando las relaciones existentes entre sus elementos. Los elementos a considerar son: programas, datos de entrada y salida, archivos, informes producidos y decisiones tomadas. 5.6 Descripcin de los Archivos En esta seccin se incluirn los formularios que contienen la informacin descriptiva de los archivos del "JOB". Esta informacin se encuentra en la seccin(5) del Manual de Diseo, y de all se tomarn solamente los formularios de los archivos que se procesan en el "JOB". 5.7 Mensajes y Parmetros de Control Se documentarn todos los mensajes que produce el "JOB", indicndose: su significado y la accin de tomar, su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin. As mismo se incluyen todos los parmetros de control y su efecto sobre el procesamiento del "JOB". 5.8 Formularios de Entrada de Trascripcin Se mostrarn todos los formularios que contengan informacin de entrada al "JOB". As mismo, se incluirn los instructivos elaborados para facilitar la trascripcin de los datos.
- 11 -
5.9 Informes que Produce
07/01/2012
En esta seccin se incluye la documentacin relacionada con el procesamiento de los informes del "JOB". Se indicar: 5.9.1 Muestra de los informes Es una muestra real de todos los informes producidos por el "JOB" 5.9.2 Distribucin y volumen de los informes Esta documentacin, facilita el control de calidad de los informes producidos por el "JOB". La informacin exigida se encuentra en la seccin (4) del Manual de Diseo, y con ella se prepara un formulario de "Distribucin y Volumen de los Informes" que incluye solamente los informes producidos por el "JOB". 5.10 Listado de las Tarjetas del Lenguaje de Control Se incluyen los listados de las tarjetas del lenguaje de control que se necesitan para procesar el "JOB". 5.10.1 Programas de utilidad usados
- 12 -
Documentacin del Usuario
07/01/2012
6. DOCUMENTACIN DEL USUARIO El objetivo del manual de documentacin del usuario es presentar la documentacin relacionada con las funciones del usuario en la operacin del sistema, se describe a continuacin el contenido de cada una de las secciones que lo integran. 6.1 Objetivo del Manual En esta seccin se indican los objetivos del manual haciendo referencia a la operacin del sistema por parte del usuario. 6.2 Polticas y Normas Se sealan las polticas establecidas en cuanto al uso del manual y operacin del sistema, de la misma manera, se indican las normas que debern seguirse en cuanto al uso de los informes, pantallas, preparacin de los formularios, ejecucin de los procedimientos, etc. 6.3 Responsabilidades Se indican los departamentos y/o cargos responsables de la operacin del sistema, con relacin a las funciones del usuario, son considerar el procesamiento de datos a travs del computador. 6.4 Objetivos del Sistema En forma narrativa se describen los alcances y objetivos del sistema, con relacin a aquellas funciones del sistema donde la responsabilidad del usuario est involucrada. 6.5 Diagrama de flujo de la Informacin Se anexa un diagrama de flujo que muestra el flujo de la informacin a travs de los distintos departamentos involucrados en la operacin del sistema, desde el origen de la informacin hasta su destino. El diagrama de flujo mostrar: formularios de entrada, ventanas, operaciones ejecutadas, decisiones, acciones tomadas e informes producidos. Este diagrama de flujo tambin se encuentra en la seccin 2 del Manual de Diseo. 6.6 Procedimientos En esta seccin debern incluirse todos los procedimientos elaborados para la operacin del sistema, dando ejemplos de su uso.
- 13 -
07/01/2012
6.7 Formularios, Ventanas, Instructivos y Diagrama de flujos Se anexarn todos los formularios, sus instructivos y diagrama de flujos que se sealen en los procedimientos incluidos en la seccin anterior, toda esta documentacin estar organizada de la siguiente manera: Formulario 1 Ventana 1 Instructivo 1 Diagrama de flujo 1 Formulario X Ventana X Instructivo X Diagrama de flujo X Los instructivos debern ser preparados de la siguiente manera: a) Ttulo: El ttulo del formulario Cdigo: El cdigo asignado al formulario, su confeccin estar regida por las especificaciones del manual de documentacin en el volumen de normas de codificacin. b) Objetivo: Una breve narrativa que indique los objetivos del formulario. c) Origen: La oficina o dependencia que llena el formulario. d) Presentacin: La forma como se presenta el formulario, se indicar: e) Frecuencia de preparacin. (diaria, mensual, semanal, eventual, otro) f) Forma de preparacin. (manual o automtica) g) Distribucin. (Oficinas formulario) h) Datos a cumplimentar: Se dan las instrucciones tendientes a facilitar el llenado del formulario, indicando el significado de cada uno de los datos del formulario. En cuanto a los diagramas de flujos, se deber preparar para cada formulario, un diagrama de flujo que indique el flujo del formulario a travs de las distintas dependencias y las acciones tomadas en cada una de ellas. o dependencias donde es enviado el
- 14 -
07/01/2012
6.8 Informes En esta accin se describen en detalle todos los informes del sistema. Las subsecciones consideradas son: 6.8.1 Descripcin y volumen de los informes Mediante un formulario diseado para este fin, se indicarn para todos los informes del sistema: a) Cdigo del informe b) Nombre del informe c) Tipo de papel d) No. Aproximado. de pginas (Volumen) e) Fecha de preparacin o frecuencia f) Copias y distribucin g) Este formulario se puede tomar directamente de la seccin 4 del Manual de Diseo. 6.8.2 Muestra de los informes Es una muestra real de todos los informes producidos por el sistema. 6.8.3 Descripcin de los informes Es una narrativa que describe en el lenguaje del usuario, la forma como leer, interpretar y utilizar la informacin contenida en cada uno de los informes del sistema. Esta informacin se encuentra en la seccin 4 del Manual de Diseo. 6.9 Responsabilidades Se indican los departamentos y/o cargos responsables de la operacin del sistema, con relacin a las funciones de usuario, sin considerar el procesamiento de datos a travs del computador.
- 15 -
Diagramacin Estructurada
7. Tips sobre programacin.
07/01/2012
El diseo. El diseo del programa es lo ms importante en programacin, con un buen diseo aseguramos que se recibir un programa que ser correcto, fcil de entender por otra persona y fcil de mantener. El aspecto ms importante del diseo es la estructura, esta debera estar basada en la estructura de los datos. La mecnica de la estructuracin (por ejemplo compilar separadamente) es mucho menos importante que el acierto en la seleccin de una estructura particular. El hacer diagramas de flujo no es disear, un diagrama de flujo oculta la estructura y es un impedimento para un buen diseo. A esto sigue que el mtodo de diseo debe asegurar, tanto como humanamente sea posible, programas correctos. La eficiencia no es usualmente el objetivo vital en el diseo, ya que en el procesamiento de datos muchos programas estn limitados a entradas y salidas. Muchas veces el costo de la creacin original y el mantenimiento de un programa, sobrepasa el costo de su procesamiento. El diseo de programas se puede ver como un procedimiento paso a paso, comenzando con la estructura de los datos a ser procesados y llegando metdicamente a la codificacin final. Se recomienda utilizar diagrama de bloques con tcnica de diseo "TOP-DOWN" y refinamiento sucesivo o "paso a paso". Con ello, podemos observar las estructuras bsicas del programa, su interrelacin y se desea, la particularidad de cada una de esas estructuras bsicas. Programas simples. Las estructuras de datos se derivan de un modelo implcito o explcito de la realidad. Un archivo de registros es un modelo de un conjunto de entes. Las estructuras de datos vistas por un programa estn forzadas por esta realidad, y por la manera mediante la cual nosotros elegimos representarlos dentro de la aplicacin. Los datos internos a un programa requieren el mismo cuidado en el diseo y en la asignacin del espacio que los datos externos. Backtracking Por definicin, ningn programa se puede requerir para procesar datos invlidos; sin embargo, los errores de los datos deben ser procesados comnmente. Algunas veces hay ms casos de error que casos buenos, ms an cuando no tenemos la necesidad de distinguir los distintos casos de error. Cuando es necesario leer un gran nmero indeterminado o inaceptable de registros, se requiere BACKTRACKING. Esto involucra el hacer selecciones basadas en asumir lo que pasar, y luego el corregir el dao si se prueba que la asuncin era equivocada. Conflictos de estructuras. El arreglo de estructuras de datos no siempre es posible o deseable. Esto es, que nosotros podramos ser incapaces o contrarios de formar una estructura de programa sencilla que corresponda simultneamente con todas las estructuras de datos. Entonces, es necesario el dividir el programa en dos o ms programas, en consecuencia es posible el disear estos programas separados, dndoles la estructura correcta de acuerdo a sus datos de E / S, ignorando las distorsiones confusas causadas por las consideraciones hechas al tratar de obtener una operacin eficiente.
- 16 -
07/01/2012
La importancia de la estructuracin. La estructuracin de programas debe estar relacionada con la estructura de datos, porque los datos incorporan las tareas que el programa debe cumplir. Los archivos de transacciones (en un sistema en lnea, la cola de mensajes de entrada) es una lista de las tareas a ser realizadas, y el archivo maestro, es sobre el cual se debe realizar el trabajo. Cada parte de cada tarea debera tener un lugar correcto en el programa, y esto solo se puede lograr si la estructura del programa refleja la estructura de los datos. El uso indiscriminado de SWITCHES es un sntoma de forzar funciones del programa dentro de una estructura que no se ajusta, esta es una desafortunada caracterstica de los computadores digitales de uso general, en los que casi cualquier programa, sin importar su mala estructuracin se puede hacer para trabajar de esta forma. Lo que importa en programacin. Cualquiera que sea el ambiente de programacin, la calidad del trabajo depende ms que todo del reconocimiento de los siguientes principios: (1)Codificar no requiere mucho esfuerzo, lo que lleva esfuerzo es el diseo y la prueba1. (2) Las dificultades en las pruebas son usualmente insolubles una vez que se ha concluido la fase de diseo. Si usted no realiza el trabajo de diseo en su etapa correspondiente, tendr luego que hacerlo ms tarde en la etapa de codificacin, cuando esto ser ms arduo y costoso. (3)Un diagrama de flujo lgico no es un diseo, esto oculta las estructuras en vez de exhibirlas. An los programas fciles son difciles; los programas difciles son imposibles. Los mejores desarrolladores escriben solamente programas fciles.
Las pruebas nunca podrn probar la ausencia de errores en los programas, solamente su presencia. - 17 -
7.1 Documentacin de Mtodos y Programas
07/01/2012
. Todo programa o mtodo tendr un encabezado donde se registrar el nombre del Programa o Mtodo contenida en una variable de nombre whPrgNom, el nmero de la versin contenida en una variable de nombre whPrgVer, una breve descripcin de las funciones fundamentales, en tal sentido se debe ser precisa y sin retrica, adems el nombre del programador que lo creo, la fecha de creacin y el registro de las modificaciones donde IIII son las iniciales del programador que efectuo la modificacin y aaaammdd la fecha de la modificacin, tal como lo muestra la ilustracin siguiente. whPrgNom = AssFcccT whPrgVer = gg.vv.pp
DESCRIPCIN: Breve descripcin de las funciones fundamentales del programa o mtodo, en tal sentido se debe ser preciso y sin retrica. CREADO POR : Nombre del Programador. CREADO EL : aaaa/mm/dd MODIFICACIONES : IIII aaammdd : Breve descripcin de la modificacin, arreglo o ajuste aplicado, en tal sentido se debe ser preciso y sin retrica. IIII aaammdd : Breve descripcin de la modificacin, arreglo o ajuste aplicado, en tal sentido se debe ser preciso y sin retrica. IIII aaammdd : Breve descripcin de la modificacin, arreglo o ajuste aplicado, en tal sentido se debe ser preciso y sin retrica. IIII aaammdd : Breve descripcin de la modificacin, arreglo o ajuste aplicado, en tal sentido se debe ser preciso y sin retrica.
- 18 -
07/01/2012
. Para aumentar la legibilidad del cdigo fuente, deber obligatoriamente mantener una estructura identada (se recomienda el uso del tabulador TAB), como lo muestran los siguientes ejemplos: 1er. Ejemplo: Visual Basic If Condicin 1 Then Accin 1 Accin 2 Accin 3 Else Accin 4 Accin 5 End if 2do. Ejemplo: Visual FoxPro Define Class GridForm as Form Width = 330 Height = 250 Caption = xxxxx.. EndDefine 3er Ejemplo DOS FoxPro Do Case Case Condicin 1 Accin 1 Case Condicin 2 Accin 2 Case Condicin N Accin N OtherWise Otra Accin EndCase . Toda rutina o procedimiento deber mantener comentarios descriptivos sobre lo que realiza y como, estos comentarios deben ser claros, concisos y sin retrica.
- 19 -
8. Diagramacin Estructurada.
07/01/2012
La Diagramacin consiste en representar los algoritmos mediante esquemas grficos, lo que permite tener una visin mucho ms clara de ellos y por consiguiente, comprenderlos mejor y traducirlos ms fcilmente al lenguaje de una computadora. Algunas de las ventajas de la diagramacin estructurada son: La flexibilidad que brinda al momento de hacer correcciones, modificaciones o ampliaciones al diagrama original, la facilidad que ofrece para localizar los errores dentro del diagrama, la claridad y ordenacin lgica a la que obliga en la presentacin del diagrama. Esto se traduce en mayor productividad en la programacin de computadores. El precursor en el uso de esta tcnica es el holands EDSGEN W. DIJKSTRA. Los smbolos que utilizamos en este manual fueron propuestos por NASSI y SCHNEIDERMANN en el ao de 1973.
La diagramacin estructurada tiene tres (3) caractersticas fundamentales: El Diagrama est segmentado en bloques. La Lgica enfoca primero los pasos generales de proceso, para luego detallarlos progresivamente. (enfoque Top-Down) Se utilizan exclusivamente las tres (3) estructuras lgicas, las de proceso, condicin (seleccin binaria) e Iteracin.
El Diagrama se ve como un conjunto de bloques y sub-bloques, organizado en forma de rbol, que se recorre en forma lgica, de arriba hacia abajo. Cada bloque realiza una funcin especfica que se puede documentar o describir con la precisin que se desee.
- 20 -
Simbologa
07/01/2012
Los smbolos que utilizaremos para la diagramacin corresponden a las tres estructuras lgicas bsicas necesarias para elaborar cualquier algoritmo, proceso, decisin e iteracin. Smbolo de proceso Este smbolo es representado mediante un rectngulo y corresponde a una accin a ejecutar. (Proceso) Ejecutar Proceso. (Sucesin)
Un diagrama puede estar formado por mltiples procesos, un proceso puede estar formado por mltiples subprocesos.
Ejecutar Ejecutar Ejecutar Ejecutar
el el el el
SubProceso SubProceso SubProceso SubProceso
1. 2. .... n.
Smbolo de condicin o decisin. Este Smbolo es representado mediante tres (3) tringulos. El tringulo central o rectngulo dividido contiene una expresin lgica, condicin, o decisin que puede tomar 2 valores posibles: VERDADERO (CIERTO) o FALSO.
Los tringulos izquierdo y derecho indican la direccin a seguir del proceso dependiendo del resultado de la decisin, CIERTO o FALSO. S la condicin es cierta es ejecutado el proceso A, s la condicin 1 es falsa se ejecutar el proceso B. Los procesos A y B pueden estar formados cada uno de ellos por otros subprocesos.
- 21 -
Smbolo de Iteracin o Ciclo.
07/01/2012
Se representa con unos rectngulos interceptados, donde se propone una expresin lgica, s la expresin es verdadera, ejecute los pasos especificados en el cuerpo del ciclo. Al terminar la ejecucin del cuerpo del ciclo, se chequea de nuevo si la expresin sigue siendo verdadera. En caso de resultar as, se ejecuta de nuevo el cuerpo de instrucciones. Cuando la expresin llega a ser falsa, no se ejecuta el cuerpo del ciclo y termina. NOTA: Hay que distinguir la diferencia entre las estructuras de condicin simple y de ciclo. En el ciclo, la condicin se vuelve a chequear cada vez que se termine de ejecutar el cuerpo del ciclo y hay repeticin de la ejecucin del cuerpo mientras la condicin sea verdadera. En la condicin simple, hay un solo chequeo que determine la direccin a tomar dentro del proceso.
Smbolo para la estructura CASE
Bsicamente es una variacin de la simbologa de la condicin, este smbolo es representado mediante tres (3) tringulos. El tringulo central o rectngulo dividido contiene una expresin lgica, condicin, o decisin que puede tomar n valores posibles.
- 22 -
Codificacin
9. Codificacin de los nombres de los archivos.
07/01/2012
Esta seccin describe como se deben codificar los nombres de los archivos de programas, datos, procedimientos, funciones y listados que componen la aplicacin.
9.1 De archivos de O Y M WssTccc. W Siempre W ss - Aplicacin. Ver Anexo 2. T Tipo de archivo P Procedimiento I Instructivo F - Formulario N Normas y Polticas ccc - Numero consecutivo dentro de la aplicacin o Aplicacin.
9.2 De Proyectos PssAccc. F Siempre P. ss - Aplicacin. Ver Anexo 2. A - Siempre A ccc - Numero consecutivo dentro de la aplicacin o Aplicacin.
9.3 De Libreras LssAccc. F Siempre L. ss - Aplicacin. Ver Anexo 2. A - Siempre A ccc - Numero consecutivo dentro de la aplicacin o Aplicacin.
9.4 De programas fuentes, mdulos, rutinas AssFcccT. A - Siempre A ss - Aplicacin. Ver Anexo 2. F Tipo de archivo. F Programas. M Mdulos. U Rutinas. S Scrips ccc - Numero consecutivo dentro de la o Aplicacin. T Funcin principal. U Actualizador. G Generador. K Calculador. L Listador. R Lector. S Clasifcador. C Copiador. A Administracin.
- 23 -
Codificacin
07/01/2012
9.5 De Formas (Ventanas) FssAcccTnn. F Siempre F. ss - Aplicacin. Ver Anexo 2. A - Siempre A ccc - Numero consecutivo dentro de la aplicacin o Aplicacin. T Funcin principal. U Actualizador. G Generador. K Calculador. L Listador. R Lector. S Clasifcador. C Copiador. A Administracin. nn..... Nmero secuencial de la forma dentro de la entidad usuaria.
9.6 De Reportes RssAcccSnn. R Siempre R. ss - Aplicacin. Ver Anexo 2. A - Siempre A ccc - Numero consecutivo dentro de la aplicacin o Aplicacin. S Siempre S nn..... Nmero secuencial de la forma dentro de la entidad usuaria.
9.7 De JOBS JssFcccT J Sienpre J ss .. Aplicacin. Ver Anexo 2. F - Frecuencia D: diaria S: semanal Q: quincenal M: mensual T: trimestral A: anual E: eventual ccc. Consecutivo dentro de la aplicacin. (000-999) T-Tipo. (U: actualiza, G: genera, L: lista, R: lee, S: clasifica, C: copia)
- 24 -
Codificacin
07/01/2012
9.8 De datos FssCcccRnn. F Tipo de archivo. D Datos convencionales(ejemplo .TXT) T Tabla de base de datos. ss .. Aplicacin. Ver anexo 2. C....... Tipo de creador. A: aplicacin S: clasificador @: administrador ccc ..... Consecutivo de la entidad que lo crea. R....... Retencin. T Temporal. M Maestra. H Histricos. nn..... Nmero secuencial del archivo dentro de la entidad que lo crea. NOTA : Ya que un procedimiento o JOB puede tener dualidad de funciones en la modalidad, prevalecer la de mayor relevancia, segn la siguiente categoras: U - Mayor relevancia. G - ...... K - S - ...... C - ...... L - ...... R - Menor relevancia.
- 25 -
Codificacin
07/01/2012
9.9 Convenciones para los nombres de los objetos y controles. Los objetos se denominarn con un prefijo coherente que facilite la identificacin del tipo de objeto. A continuacin se suministra la lista de convenciones establecidas para algunos de los objetos permitidos por Visual Basic y Visual FoxPro, las mismas son adoptadas de los estndares de MicroSoft.
Tipo de control
Panel 3D Botn animado Casilla de verificacin(Check Box) Cuadro combinado, cuadro lista desplegable Botn de comando(Command Botton) Dilogo comn Comunicaciones Control de datos Cuadro combinado enlazado a datos Cuadrcula enlazada a datos Cuadro de lista enlazado a datos Cuadro de lista de directorios(Dir List Box) Cuadro de lista de unidades(Drive List Box) Cuadro de lista de archivos(File List Box) Formulario(Form) Marco(Frame) Medidor Grfico Cuadrcula Barra de desplazamiento horizontal Imagen (Image) Estado de tecla Etiqueta(Label) Lnea(Line) Cuadro de lista(List Box) Mensaje MAPI Sesin MAPI MCI Formulario MDI secundario Men(Menu) MS Flex Grid MS Tab ActiveX Esquema
Prefijo
pnl ani chk cbo cmd dlg com dat dbcbo dbgrd dblst dir drv fil frm fra gau gra grd hsb img key lbl lin lst mpm mps mci mdi mnu msg mst ole out
Ejemplo
pnlGrupo aniBuzn chkSloLectura cboIngls cmdSalir dlgArchivoAbrir comFax datBiblio dbcboLenguaje dbgrdResultadoConsulta dblstTipoTarea dirOrigen drvDestino filOrigen frmEntrada fraLenguaje gauEstado graIngresos grdPrecios hsbVolumen imgIcono keyMaysculas lblMsjAyuda linVertical lstCdigoDePoltica mpmEnviarMsj mpsSesin mciVdeo mdiNota mnuArchivoAbrir msgClientes mstPrimero oleHojaDeTrabajo outDiagramaDeOrg
- 26 -
Codificacin
Tipo de control
Pen Bedit Pen Hedit Trazo de pluma Imagen (Picture) Clip de imagen Informe Forma(Shape) Cuadro de nmero Cuadro de texto (Text Edit Box) Cronmetro(Timer) Arriba-abajo Barra de desplazamiento vertical Control deslizante Lista de imgenes Vista de rbol Barra de herramientas TabStrip Barra de estado Lista Barra de progreso RichTexBox Boton de Opciones(Option Botton) Picture Box
07/01/2012
Prefijo
bed hed ink pic clp rpt shp spn txt tmr upd vsb sld ils tre tlb tab sta lvw prg rtf opt pct
Ejemplo
bedNombre hedFirma inkMapa picVGA clpBarraDeHerramientas rptGananciasTrimestre1 shpCrculo spnPginas txtApellido tmrAlarma updDireccin vsbVelocidad sldEscala ilsTodoslosIconos treOrganizacin tlbAcciones tabOpciones staFechaHora lvwEncabezados prgCargarArchivo rtfInforme optAcciones pctCaja
Prefijos sugeridos para mens Las aplicaciones suelen usar muchos controles de men, lo que hace til tener un conjunto nico de convenciones de nombres para estos controles. Los prefijos de controles de mens se deben extender ms all de la etiqueta inicial mnu, agregando un prefijo adicional para cada nivel de anidamiento, con el ttulo del men final en la ltima posicin de cada nombre. En la tabla siguiente hay algunos ejemplos.
Secuencia del ttulo del men

Archivo Abrir Archivo Enviar correo
Nombre del controlador del men

mnuArchivadorAbrir mnuArchivoEnviarCorreo
Secuencia del ttulo del men

Archivo Enviar fax Formato Carcter Ayuda Contenido
Nombre del controlador del men

mnuArchivoEnviarFax mnuFormatoCarcter mnuAyudaContenido
- 27 -
Codificacin
07/01/2012
Cuando se usa esta convencin de nombres, todos los miembros de un grupo de mens determinado se muestran uno junto a otro en la ventana Propiedades de Visual Basic. Adems, los nombres del control de men documentan claramente los elementos del men a los que estn subordinados.
- 28 -
Codificacin
07/01/2012
Para denominar elementos propios de las bases de datos, se aplicaran la siguiente codificacin:
Vistas (Views) : WWssCcccRnn WW......Tipo de Vista. vw De SQL vf De Visual FoxPro. ss ....... Aplicacin. Ver anexo 2. C........ Tipo de creador. A: aplicacin S: clasificador @: administrador ccc...... Consecutivo de la entidad que lo crea. R......... Retencin. T Temporal. M Maestra. H Histricos. nn....... Nmero secuencial del archivo dentro de la entidad que lo crea. Procedimientos Almacenados(Store Procedures) SPssAcccT SP.........Siempre sp ss..........Aplicacin. Ver Anexo 2. A..........Accesibilidad. E Editable. U No Editable. ccc - Numero consecutivo dentro de la o Aplicacin. T - Tipo de programa. U Actualizador. G Generador. K Calculador. L Listador. R Lector. S Clasifcador. C Copiador. A Administracin. ndices(Index), la cantidad de dgitos deber ser no mayor a treinta (30), la abreviatura inicial deber ser la siguiente: Para las claves primarias(Primary Keys): pk nombre de la tabla. Para las claves forneas(Foreing Keys): fk nombre de la primera tabla y nombre segunda tabla. Para los ndices: Ik nombre del 1er. campo, nombre del 2do campo ....... nombre del Nmo. Campo.
- 29 -
Codificacin
07/01/2012
Codificacin de los nombres de las variables de trabajo y de datos. Esta seccin describe como se codificarn los nombres de los datos en los archivos y en los programas que componen las aplicaciones. Bsicamente la estructura de la codificacin identifica y califica al dato dentro de las aplicaciones en funcin de su ubicacin, uso y contenido, de ah que todas las variables de trabajo (datos) que son establecidas y definidas dentro de estas, inician sus nombres con los prefijos de la relacin en minsculas, donde xxx...xxx es una combinacin de abreviaturas que describen de alguna manera el contenido. Variables de memoria (tt XXX...XXX) tt Prefijo segn tipo de variable. wc........Contadores wa........Acumuladores y Totales. wk........Constantes. wx........Arreglos. ws........Switchs e Indicadores. wt.........Horas. wf........Fechas. wh........Contenedores. wi........ndices.
XXX...XXX : Para las abreviaturas se utilizar las referidas en el anexo 2 y se aplicar el estndar de escritura HumpBack2, para los nombres de las columnas, campos o atributos de una tabla o archivo de datos convencional, se aplicar los mismas reglas descritas omitiendo el prefijo. Ejemplos : wcFchCPU Fecha del CPU MtoUltCom Monto ltima compra.
Utilizar letras maysculas para identificar el comienzo de porciones significativas del nombre de las variables y datos. - 30 -
Codificacin Codificacin de mensajes
07/01/2012
Para incorporar una mayor independencia al programa del desarrollador, los posibles mensajes que emita aqul sern codificados de acuerdo a lo estipulado a continuacin: Para archivos de BD: A0 CCCC PPPPPPPP FFFFF DDDD SSSSS KK...KK Donde : A0 : Cdigo del grupo.(Constante) CCCC : Nmero consecutivo del mensaje. PPPPPPPP : Nombre del programa.(Nombre del programa o Mtodo) FFFFF : Comando SQL DDDD : Nombre de la tabla. SSSSS : Status del DBMS. ..KK : Clave.(KEY) Para archivos convencionales A1 CCCC PPPPPPPP FFFFFFFF AAAAAAAAAA SS KK... KK Donde : A1 : Cdigo del grupo.(Constante) CCCC : Nmero consecutivo del mensaje. PPPPPPPP : Nombre del programa.( Nombre del programa o Mtodo) FFFFFFFF : Comando o accin. Nombre del archivo. SS : Status de respuesta. ..KK : Clave. Que no refieran a archivos A2 CCCC PPPPPPPP XX...XX Donde : A2 : Cdigo del grupo.(Constante) CCCC : Nmero consecutivo del mensaje. PPPPPPPP : Nombre del programa.( Nombre del programa o Mtodo) ..XX : Mensaje. Especificacin de mensajes Para todos y cada uno de los mensajes deber llenarse la forma de especificacin de mensajes, el cual contiene la descripcin, explicacin y accin a tomar en caso de sucederse el mismo. Ax CCCC PPPPPPPP EXPLICACION : Una explicacin concisa del porque del mensaje. ACCION : La(s) accin(es) a tomar.
- 31 -
Codificacin
Reportes Impresos.
07/01/2012
A continuacin el formato para los Reportes Impresos, las reas del formato que son de aplicacin obligatoria son el rea de titulacin (las tres primeras lneas) y rea de terminacin (ltima lnea), en las primeras se identifican el lugar de emisin, el cdigo del reporte, se titula y subtitula el reporte, se muestra la fecha y hora de emisin, y el numero el paginado, el cuerpo del reporte estar subordinado al uso y aplicacin del mismo, no obstante todo reporte deber totalizar por lo menos la cantidad de registros procesados, para cerrar el reporte se imprime la lnea de cierre como lo muestra la imagen 1.
- 32 -
Codificacin
Interfase Grfica.
07/01/2012
El desarrollo bajo herramientas de naturaleza grfica implica un efecto visual sobre el usuario, este efecto puede ser agradable o no, dependiendo de la apariencia que tengan las ventanas y dems objetos que intervienen, este efecto califica la comodidad y funcionalidad como el usuario opera y se desplaza de una ventana a otra, entonces se clasifica de amigable toda aquella ventana o grupo de ventanas (Aplicacin) que es fcil de entender su distribucin y operacin. Por lo antes expuesto se impone la necesidad de aplicar ciertos estandares en los diseos de las interfases grficas, estos estardares tienen como objetivo mantener la uniformidad de las aplicaciones, mejorar su calidad y disminuir los tiempos de codificacin, a continuacin se describen una serie de normas que debern ser adoptadas durante su proceso de diseo y escritura. Aplicar la siguiente lista de comprobacin, confirma que se disea una buena interfase grfica que proporciona la mayor eficiencia posible al usuario. 1ro. Su aplicacin opera facilmente con un numero mnimo de pasos. 2do. La interrupciones no obligan a reiniciar el sistema. 3ro. Los eventos que tienen que leer un archivo. Leerlo antes de usar su aplicacin. Mantener el estardar de Windows. La Fuente. El tipo de fuente deber ser ARIAL, el tamao depender de la aplicacin que se este desarrollando.
- 33 -
Codificacin
Los Colores de los Ttulos
07/01/2012
Los Colores de las Ventanas
- 34 -
Codificacin
07/01/2012
De los Iconos. El tamao de los iconos del escritorio tendrn 32 x 32, para las barras de herramientas y mens 16 x 16, adicionalmente la apariencia de las barras de herramientas sern las siguientes: Estandar
Edicin
Ver
Exportar
- 35 -
Codificacin
07/01/2012
De los Botones. Se utilizarn los botones ACEPTAR y CANCELAR o SI y NO, los mismos debern estar alineados en la parte superior derecha o inferior derecha del cuadro de dialogo, ACEPTAR siempre ser el primer botn seguido por CANCELAR, s no tiene un botn ACEPTAR, entonces CANCELAR deber estar despus de todo los dems. Ejemplo ACEPTAR y CANCELAR:
Ejemplo SI y NO:
Ejemplo SI, NO y CANCELAR:
- 36 -
Codificacin
De los Mens. Incluir en los mens desplegables formas que ayuden al usuario final a ubicar rpidamente una opcin, su tamao ser 16 x 16. . Ejemplo :
07/01/2012
Los mens contextuales tambin denominados mens emergentes, proporcionan un mecanismo eficiente para que el usuario acceda a las operaciones de los objetos. Estos evitan que el usuario mueva el puntero a la barra de men o a la barra de herramientas, an cuando se evitar su uso como nica forma que tenga el usuario de acceder a una operacin en especifica, su tamao tambin ser 16 x 16. . Ejemplo de men contextual:
- 37 -
Codificacin
07/01/2012
De las Barras de Herramientas. Las Barras de herramientas se colocarn debajo de la barra de men o barra de ttulo, se incluirn figuras o formas que ayuden al usuario final a ubicar rpidamente una opcin, y su tamao ser de 16 x 16. 1er. Ejemplo de ubicacin debajo de la barra de men:
2do. Ejemplo de ubicacin al extremo inferior derecho:
- 38 -
Codificacin
Ejemplo de figuras o formas que ayuden al usuario final:
07/01/2012
- 39 -
Codificacin
De las Ventanas. Para facilitar los siguientes colores: AZUL Corresponde ROJO Corresponde NEGRO Corresponde Ejemplo:
07/01/2012
la identificacin de los tipos de datos, los ttulos de los campos tendrn a campos de solo despliegue. a campos con consultas para que el usuario seleccione una alternativa. a campos de entrada de datos.
Al ingresar o modificar datos en una tabla se procurar permitir incluir o modificar toda la informacin y posteriormente procesar la inclusin o cambio con solo hacer clic en el botn de ACEPTAR.
- 40 -
Codificacin
07/01/2012
Al momento de realizar una consulta es importante que el usuario pueda ordenar la informacin que esta visualizando de manera ascendente o descendente con solo hacer clic en la cabecera de las columnas. Ejemplo :
De los Mensajes. De Informacin, son aquellos que proporcionan informacin sobre el resultado de un comando. No ofrece opciones al usuario; el usuario confirma el mensaje haciendo clic sobre el botn ACEPTAR. Smbolo asociado :
De Advertencia, son aquellos que avisan al usuario de una condicin o situacin que requiere una decisin por su parte antes de continuar, como una accin inminente con consecuencias irreversibles y potencialmente destructivas. El mensaje puede tener la forma de una pregunta como por ejemplo Guardar los cambios de Mi Informe?.
Smbolo asociado :
De Problema, son aquellos que informan al usuario de un problema serio que requiere intervencin o correccin antes de poder continuar con el trabajo.
Smbolo asociado :
- 41 -
Codificacin
07/01/2012
De los Punteros. (Cursores) Las formas de los punteros dependern de los objetos o eventos en donde se apliquen como se indica a continuacin:
Apuntar, seleccionar o mover.
Seleccionar texto.
Procesando una operacin.
Procesando una operacin como una tarea de fondo, el puntero sigue siendo interactivo.
Vista de aumento.
No disponible como destino de una operacin de arrastrar y soltar.
Navegar hasta la referencia vinculada.
De las Teclas de Navegacin. El siguiente grupo de teclas representan las teclas de navegacin bsicas.
- 42 -
Codificacin
De los Comandos.
07/01/2012
El siguiente grupo de teclas representan las teclas de comandos bsicas.
- 43 -
Codificacin
De los Controles.
07/01/2012
Agrupacin de controles. Agrupar los campos que se relacionan con una categora de informacin bajo un titulo que los identifique, deber tener las siguientes caractersticas:
Fuente ..:Arial Tamao :Nueve(9) Estilo.....:Negrita,Sombreado
Caja de chequeo. Al utilizar este control, al escoger las distintas caractersticas u opciones, los ttulos debern tener las siguientes caractersticas: Fuente ..:Arial Tamao :Nueve(9) Estilo.....:Negrita, S desea resaltar caracterstica en especial.
alguna
Botones de comandos. Estos controles debern tener las siguientes caractersticas:
Fuente ..:Arial Tamao :Nueve(9) Estilo.....:Negrita, S desea resaltar alguna caracterstica en especial.
Botones de opcin. Este control deber tener las siguientes caractersticas: Fuente ..:Arial Tamao :Nueve(9) Estilo.....:Normal.
- 44 -
Codificacin
07/01/2012
Formato Tab. Este formato tendr las caractersticas siguientes:
Fuente : Arial Tamao : Diez(10) Estilo.....: Negritas.
Barra de Desplazamiento Vertical. Este control tendr las siguientes caractersticas :
Fuente : Arial Tamao : Diez(10) Estilo.....: Normal.
Caja de Textos (Ingreso de Datos). El ttulo de este control deber tener la siguientes caractersticas: Fuente ..: Arial Color ....: Negro Tamao : Nueve(9) Estilo.....: Negrita.
Ingresar Datos:
Caja de Textos (Solo Despliegue de Datos) El ttulo de este control deber tener la siguientes caractersticas: Fuente ..: Arial Color ....: Azul. Tamao : Nueve(9) Estilo.....: Negrita. Fondo ...: Transparente.
Despliegue:
V.- 10.542.639
Caja de Combo. El usuario ingresa informacin y adems podr escoger una opcin. El ttulo de este control deber tener la siguientes caractersticas: Fuente ..: Arial Color ....: Rojo Tamao : Nueve(9) Estilo.....: Negrita.
Ingresar y Consultar Datos:
...
- 45 -
Codificacin
07/01/2012
Anexo 1 Relacin de cdigos de Aplicacin. 01 Administracin OS 02 Administracin Red 03 Administracin BD 10 Almacn 11 Inventario Locatel 12 Kardex 13 Inventario Equipos 20 Facturacin LOCATEL 21 Recetura 22 Ventas 23 VIDA 24 Alquiler 25 Unidosis 26 Facturacion Equipos 27 Facturacion Servicios 30 Afiliacin 31 Clientes 32 Convenios 40 Catalogo 41 Etiquetado 42 Proveedores 50 Activos Fijos 51 Contabilidad 52 DPC10 53 Nomina 54 Tesorera 60 Utilitarios 61 Respaldos 71 Costeos 72 Ordenes 73 Pagos 74 Compras Equipos 80 Call Center 81 Nutricin 82 HomeCare 83 V.I.P. 90 P.O.S. 91 Caja
- 46 -
Codificacin
Anexo 2 Relacin de Abreviaturas Abreviatura / Siglas Abreviatura / Siglas Abreviatura / Siglas EAN Edd Edo Efec Eml Emp Ene Eqp Err Est Est Etq Exe Eje Exe Exi Fac Farm Fax Fch Feb Fin Fnl For Fra Frm Gar Ger Gre Grp Hab Hgr His Hom Hra Hst ID Imp Inc Inf
07/01/2012
1er 2do 3ro Abo Abr Acc Acu Afi Ago Aho Aju Alg Alm Alq Alt AMD Ao Ant Ape Apl Apr Arc Asi ATM Aut Bar Bas Bck Bco Ben Bs Bul Caj Can Cap Cat Ccs Cda Ced
Significado Primero Segundo Tercero Abono Abril Acceso Acumulado Afiliacin / Afiliado Agosto Ahorro Ajuste lgebra Almacn Alquiler Altura Ao,Mes y Dia Ao(s) Antes / Anterior Apellido(s) Aplicacin Aprobacin Archivo Asiento Cajero Automtico Automtico Barra Base Detrs / Respaldo Banco Beneficiario Bolvares Bulto Caja / Cajero Cancelar / Cantidad Capital Catalogo / Categora Caracas Ciudad Cdula
Chq Cia Clb Cli Cll Cm Cmd Cmn Cod Com Com Com Con Cos Cpy Cre Cta Ctt Cub Cut Dat Deb Del Dep Des Des Det Dev Dia Dic Dif Dir Dkk Dll DMA Doc Dom Dpt Dsd Dsk
Significado Cheque Compaa Club Cliente Calle Centimetro Comando Comunicacin Cdigo Compra Comprobante Comercio / Comercial Contrato Costo Copia / Copiar Crdito Cuenta Cassette Cbico / Cubicacin Cuota Dato Debito Eliminar / Borrar Dependencia Descuento Despus Detalle / Detallado Devolucin Da (s) Diciembre Diferencia / Diferido Direccin Diskette Dollar Da, Mes y Ao Documento Domingo Departamento Desde Disco
Significado EAN Edad Estado Efectivo E mail Empleado / Empresa Enero Equipo Error Establecimiento Estadstica Etiqueta Exento Ejemplo / Ejecutar / Eje Ejecutable Existencia Factura / Facturar Farmacia Fax Fecha Febrero Fin Final Formula Franquicia Forma / Formato Garanta Gerencia / Gerencial Gregoriano Grupo Habitacin Hogar Historia / Historico Hombre Hora Hasta Identidad Impuesto / Importe Incluido / Incorporado Informacin
- 47 -
Codificacin
Ini Ins Int Inv IP Itm IVA Jfe Job Jue Jul Jul Jun Key Kg Km Lcl Loc Loc Log Lst Lee Lun Mar Mas Max May Med Men Mes Mie Min Min Mm Mnl Mon Mra Mrk Mrz Msc Sts Suc Sum Sup Sxo Tda Tip Tlf Inicial Insertar / Crear Inters Inventario IP Item(s) IVA Jefe / Jefatura Trabajo Jueves Julio Juliano Junio Key Kilogramo Kilmetro Local Localizador Localizar / Localizador Log Lista Lee / Leer Lunes Martes Mas Mximo Mayo Medio / Medico Menos Mes(es) Mircoles Mnimo Minuto Milmetro Manual Moneda Mora Marca Marzo Miscelneos Status Sucursal Suma / Sumatoria Supervisor Sexo Tienda Tipo Telfono Mt Mto Muj Myr Nac Net New NIT No Nom Not Nov Nro Nvd Nvl Obs Oct Ofc Off OFL Ok Old On ONL Ord Out Pag Pas PC PdU Ped Per Pes Pln PLU Plz Por POS Pos Ppl Metro Monto Mujer Mayor Nacimiento / Nacionalidad Net Nuevo NIT No Nombre Nota Noviembre Numero Novedad Nivel Observacin Octubre Oficina / Oficial Apagado (Off) Off Line (Fuera de Lnea) Ok Viejo Encendido (On) On Line (En Lnea) Orden Fuera Pago / Pagado Pasaporte Computadora Personal PdU Pedido Perodo / Permiso Peso Plan PLU Plazo Porcentaje POS Posicin / Posterior Principal Pre Prg Prn Prm Pro Prv Prx Pto Rec Ref Reg Rem Rep RIF Rng Rnk Rut Rut Sal Sap Sec Seg Sel Sel Sep Ser Sgl Si Sig Sis SKU Sld SQL Sr. Sra Srl Srta Srv Stk Str
07/01/2012
Precio Programa Printer Promedio Producto Proveedor Prximo Puerto / Punto Receta / Rcipe Referencia Rgimen / Registro Remedio Reporte RIF Rango Ranking Ruta Rutina Salud Sbado Secuencia / Secuencial Segundo Seleccin Seleccionar Septiembre Serie / Serial Siglo Si Signo Sistema SKU Saldo SQL Seor Seora Serial Seorita(o) Servicio Stock Store (Tienda)
- 48 -
Codificacin
TLL TPD Tra Tra Trf Trj Ttl Tur Txs Ubi Ult Und Upd Urb USA Usr Utl Val Vda Vdr Ven Vie Vig Vnz Vod Vol Vta W2k W98 WNT WXP Zip Zta Talla Terminal Porttil de Datos(PERCON) Traspaso / Traslado Transporte Tarifa Tarjeta Total Turno Transaccin Ubicacin Ultimo Unidad Actualizar Urbanizacin USA Usuario Utilidad Valor Vida Vendedor Vencimiento Viernes Vigente Venezuela / Venezolano(a) Void Volumen Venta Windows 2000 Windows 98 Windows NT Windows XP Zip Zeta
07/01/2012
- 49 -

Manual de Documentación

Diunggah oleh

Informasi Dokumen

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Manual de Documentación

Diunggah oleh

Hak Cipta:

Format Tersedia

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Documentacin del Usuario

Nelson Alejandro Meza Rojas Manual de Documentacin

Documentacin del Usuario

Nelson Alejandro Meza Rojas Manual de Documentacin

Documentacin del Usuario

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Ejecutar Ejecutar Ejecutar Ejecutar

SubProceso SubProceso SubProceso SubProceso

Nelson Alejandro Meza Rojas Manual de Documentacin

Smbolo para la estructura CASE

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Secuencia del ttulo del men

Nombre del controlador del men

Secuencia del ttulo del men

Nombre del controlador del men

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Codificacin Codificacin de mensajes

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Los Colores de las Ventanas

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Ejemplo SI, NO y CANCELAR:

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

2do. Ejemplo de ubicacin al extremo inferior derecho:

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Nelson Alejandro Meza Rojas Manual de Documentacin

Apuntar, seleccionar o mover.

Procesando una operacin.

No disponible como destino de una operacin de arrastrar y soltar.

Navegar hasta la referencia vinculada.

Nelson Alejandro Meza Rojas Manual de Documentacin

El siguiente grupo de teclas representan las teclas de comandos bsicas.

Nelson Alejandro Meza Rojas Manual de Documentacin

Fuente ..:Arial Tamao :Nueve(9) Estilo.....:Negrita,Sombreado