Page 1

Té c n i c a s d e Programación Armando J. Matos M.

23.3.2013 Número 1

Contenido Importancia Pag. 2 Estandarización Pag. 2 Ventajas de la Estandarización Pag. 2 Normalización Pag. 3 Teoría General de los Manuales de Documentación Pag.3

Edición especial que define y da una breve explicación sobre la importancia de la documentación de software

Manual Administrativo Pag. 4

Documentación de Software

Manual de Usuario Pag. 5 Manual de Captación Pag. 6 Manual de Operación Pag. 7 Código Fuente Pag. 7

La documentación consiste en un material que explica las características técnicas y la operación de un sistema. Es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo, para permitir auditoria del sistema y para enseñar a los usuarios como interactuar con el sistema. Existen varios tipos de documentación. La de programas, que explica la lógica de un programa e incluye descripciones, diagramas de flujo, listados

de programas y otros documentos; la de usuarios en forma general la naturaleza y capacidades del sistema y cómo usarlo. Esta documentación también es conocida como registro físico y contiene los siguientes elementos: * * * * *

Manual Administrativo Manual de Usuario Manual de Captación Manual de Operación Código fuente

Estos detallados en sección correspondiente.

su


Importancia de la Documentación de Software

L

a documentación en un proyecto de software es importante porque permite conservar la historia, facilita la utilización por parte del usuario, garantiza la permanencia y disminuye los costos de operación y de ejecución del proyecto como tal. La importancia de la documentación bien podría ser comparada con la importancia de poseer una

Póliza de Seguro; mientras Sistema de Información, sin todo va bien no existe la embargo, frecuentemente precaución de confirmar si es la parte a la cual se nuestra Póliza de Seguros dedica el menor tiempo y está o no vigente. se le presta menos atención. La ¿Por que es documentación Siempre se importante? debe adecuada y completa, de una documentar un aplicación que se sistema como si desea implantar, estuviera a punto de mantener y actualizar en marcharse y desprenderse forma satisfactoria, es del proyecto esencial en cualquier

Estandarización

T

oda documentación que se relacione con un sistema, ya sea manual o por computadora, sencillo o complejo debe reunir los siguientes requisitos básicos: • Debe ser rotulada con claridad y bien organizada, con secciones claramente indicadas, almacenarlas en carpetas e índice.

• Los diagramas deberán • La documentación ser claros, no aglomerados siempre se conserva y la escritura manuscrita actualizada. deberá ser legible. Aún cuando las normas • La documentación de documentación varían deberá ser completa. de una instalación a otra, es esencial que dentro de una • Se incluirá una leyenda organización, se utilice un o explicación de los solo método. términos utilizados.

Ventajas de la Estandarización • Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas. • Es útil para cualquiera que tenga la responsabilidad del Page 2

mantenimiento sistemas.

de

los

• Asegura que el sistema opere correctamente.

• Ayuda a los analistas y • Los recursos que se diseñadores de sistemas en disponen se utilizan el trabajo de integración de eficientemente . sistemas.

Newsletter Header


Normalización

E

l proceso de normalización asegura que los estándares esten completos, actualizados, documentados y legibles. Para que se cumplan los estándares es recomendable auditar

permanentemente, evaluar si los estándares establecidos son los requeridos y hacer los cambios necesarios para que dichos estándares sean los apropiados.

Teoría General de los Manuales de Documentación

D

urante el desarrollo de un sistema, desde su concepción hasta su puesta en marcha se ha generado gran cantidad de documentos, que en muchas ocasiones se han visto modificados por documentos posteriores debido a cambios en el sistema. Para evitar confusiones en las revisiones de la documentación se desarrollan diferentes tipos de documentos dirigidos a las personas que trabajarán con el sistema y para facilitar el mantenimiento del mismo. La documentación de un

sistema debe ser marcada adecuadamente, bien organizada actualizada y completa; todos los términos utilizados deben explicarse. La documentación se hará disponible a todos los usuarios de acuerdo a sus necesidades.

subtítulos. • Utilizar formas activas en lugar de pasivas. • No emplear frases largas que presenten hechos distintos.

• No hacer referencia a una información solamente El estilo de redacción de con el número de referencia. los manuales de documentación debe ser: • Concreto. • Ser preciso y definir los términos utilizados. • Utilizar párrafos cortos. •

Utilizar

títulos

y


Manual Administrativo

S

irve 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 de consulta una vez que el Sistema ha sido implantado. Aquí se detallan siguientes puntos:

los

Planteamiento: Este punto tiene como finalidad registrar los antecedentes que servirán de partida al desarrollo del análisis del sistema. Objetivos del Sistema: 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: deben quedar especificados los documentos fuentes que

Page 4

inician las operaciones del actividades para la creación sistema así como la del sistema, tales como: información detallada de análisis, aquellos programació conceptos n, que elabora Es punto de partida al serán los ción Sistema propuesto datos a de captar por formas, y el sistema. otros. Salidas del Sistema: en este punto, solamente se describirán los resultados de mayor importancia obtenidos a través de todo el proceso. 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.

Consideraciones Generales del Nuevo Sistema: en este punto se deberá señalar las ventajas, desventajas, y principales diferencias del nuevo sistema con el anterior, tales cómo seguridad, disminución de costo, ahorro de tiempo, flexibilidad, confiabilidad y otros.

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

Newsletter Header


Manual de Usuario

E

xpone 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. Objetivos: que el usuario conozca cómo preparar los datos de entrada, que el usuario aprenda a obtener los resultados y los datos de salida, debe servir como manual de aprendizaje y como manual de referencia, debe definir las funciones que debe realizar el usuario y también debe informar al usuario de la respuesta a cada mensaje de error. Pasos para desarrollar el manual de usuario: • Identificar los usuarios del sistema. • Definir los diferentes tipos de usuarios. • Definir los módulos en que cada usuario participará.

Page 5

Importancia De Usuario

Del

Manual especificarse los archivos de entrada, salida, los resultados, El Manual revisiones de y Permite al usuario Usuario proces conocer el detalle de facilita el os conocimien manuale las activiades to de los s. documentos a los que se pueden dar entrada por Explicación Genérica de computadora, los formatos las Fases del Sistema: en de los documentos, las este punto se explica en operaciones que utiliza de forma específica y detallada entrada y salida de los todas las operaciones que datos, el orden del aparecen representadas en tratamiento de la forma gráfica en el computadora con los datos diagrama particular. introducidos, el momento en que se debe solicitar una Instalación del Sistema: operación deseada, los proporciona detalles resultados de las completos sobre la forma operaciones realizadas a de instalar el sistema en un partir de los datos ambiente particular. introducidos. Iniciación al Uso del Contenido Sistema: aquí se explica cómo iniciarse en el sistema Diagrama general del y cómo se pueden utilizar sistema: muestra en forma sus cualidades comunes. condensada el flujo general Esta documentación debe de la información y de las decir al usuario cómo salir actividades que se realizan de un problema cuando las en el sistema. Proporciona cosas funcionan mal. una visión general del sistema. Representar los diagramas utilizando para ello diagramas de bloques. Diagrama particular detallado: presentar gráficamente todos los pasos que se efectúen dentro del departamento usuario a quien está dirigido este manual. Deben

Newsletter Header


Manual de Captación

P

ermite tener una clara visión del proceso de Captación de los datos 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. Contenido Diagrama General del Sistema: 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

Page 6

captados los datos.

captura de los datos o cualquier condición fuera de lo normal.

• Explicación Genérica de Las Fases Caduc Permite tener una clara idad Del visión del proceso de Sistema: de es una Docum Captación de los explicación entos datos clara, breve Fuentes: de todos los establecer por módulos que se presentan escrito la fecha de en el diagrama general. caducidad de los documentos fuentes, el fin • Equipo Utilizado Para La a que han de destinarse ya Captación sea para su destrucción, devolución o conservación Se debe crear un en un archivo. instructivo que permita al usuario el entrenamiento del sistema. Debe contener siguientes puntos:

los

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. Entrenamiento del Software de la aplicación: explicación del software utilizado en complemento al sistema. Ejemplo: como entrar y salir del sistema. Situaciones Anormales: se presentan mensajes que se emiten al momento de la

Newsletter Header


Manual de Operación

E

ste manual contiene la información que permite al personal de operación utilizar en forma eficiente la operación de los sistemas de procesamiento electrónico. Contenido Diagrama General del Sistema: 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). Diagrama General del Flujo del Proceso Electrónico: se representa en este diagrama todo el ambiente periférico que interactúa en el sistema en cuanto a: entradas

manuales, medios • Formato en que son magnéticos y dispositivos captados los datos. de salida. La simbología a utilizar debe ser establecida • Instructivo De como estándar. (Ejemplos: Operación Por Programa cintas, discos, disquetes). • Se debe desarrollar por cada programa del sistema. Explicación Genérica de Incluye Diagrama las Fases del Sistema: es electrónico del programa. una explicación clara, breve de todos los módulos que se presentan en el Diagrama general descrito anteriormente. Diagrama de Pantallas del Sistema: se presenta en este punto el flujo del sistema en las pantallas utilizadas por cada módulo. Puntos a documentar en una pantalla: • Explicación recorrido en pantalla.

del

Código Fuente

D

urante la implementación, cuando se está programando, es necesario comentar convenientemente cada una de las partes que tiene el programa. Estos comentarios se incluyen en el código fuente con el objeto de clarificar y explicar cada

Page 7

elemento del programa, se deben comentar las clases, las variables, los módulos y en definitiva todo elemento que se considere importante.

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 Esta documentación tiene otra persona distinta al como objeto hacer más programador inicial. comprensible el código fuente a otros

Newsletter Header


Documentaci贸n de Software Tecnicas de Programaci贸n

Universidad Nueva Esparta Reducto a Glorieta Nro 73 phone: 58-212-4849977 web: http://www.alfa.une.edu.ve/ une/

Dise帽ado por: Armando Matos C.I: 12.959.655

Documentación de Software  

Documentación de Software

Read more
Read more
Similar to
Popular now
Just for you