o Introducción a los estándares de calidad.
o
Forma de trazabilizar un algoritmo.
o
Formas y técnicas de documentar algoritmos y programas.
o
Introducción a la elaboración del manual del sistema, usuario y
programas.
o
Técnicas de escritura y pruebas de algoritmos y programas.
Documentación.
Una vez
diseñado y bien estructurado un algoritmo, la siguiente actividad a
desarrollar, sumamente importante
en programación, es producir programas bien documentados, para que se cumplan
los objetivos
básicos, que los programas sean legibles, comprensibles y fácilmente
modificables.
La
documentación incluye descripciones, comentarios, especificaciones, incluso un
breve manual de uso si el
algoritmo es suficientemente extenso.
Tenemos
dos tipos de documentación en el desarrollo de algoritmos bien diseñados:
a)
Documentación externa: Incluye la escritura de información que es exterior al
cuerpo del algoritmo.
Puede incluir, además de todas las especificaciones detalladas, una explicación
extensa del desarrollo
del algoritmo y de las modificaciones sufridas. Deben añadirse igualmente descripciones detalladas
del problema, de los módulos que lo componen, adjuntando un diagrama jerárquico
del diseño descendente
y por último un manual de usuario donde se explicará al cliente (o al profesor
en su defecto) como debe
usarse el programa. Esta documentación debe adjuntarse sólo en el caso de que
los algoritmos sean
suficientemente grandes, lo que se consideran aplicaciones informáticas de
cierta envergadura, divididas
en varios programas.
b)
Documentación interna: Incluye la escritura de información que se suministra
con el cuerpo del algoritmo.
Estará formada por comentarios, código autodocumentado e impresión agradable
del texto del pseudocódigo.
La
documentación de sistemas es el conjunto de información que nos dice qué hacen
los sistemas, cómo lo hacen y para quién lo hacen. La
documentación consiste en 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 y a los
operandos como hacerlo funcionar.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 del usuarios en forma general la naturaleza y capacidades
del sistema y cómo usarlo.Muchas
organizaciones tienen lo que se conoce como un "programa de
documentación", el cual consiste en una política formal cuya documentación
se muestra como algo que debe prepararse en forma rutinaria para cada programa
de cómputo, archivo y nuevos sistemas.Importancia
De
La Documentación De Sistemas
La Documentación De Sistemas
La
importancia de la documentación bien podría ser comparada con la importancia de
la existencia de una Póliza de Seguro; mientras todo va bien no existe la
precaución de confirmar si nuestra Póliza de Seguros está o no vigente.
La
documentación adecuada y completa, de una aplicación que se desea implantar,
mantener y actualizar en forma satisfactoria, es esencial en cualquier Sistema
de Información, sin embargo, frecuentemente es la parte a la cual se dedica l
menor tiempo y se le presta menos atención.Siempre se
debe documentar un sistema como si estuviera a punto de irse a Siberia el
siguiente mes, para nunca volver. Si la documentación del sistema es incompleta
el diseñador continuamente estará involucrado y no podrá moverse a otra
asignación.
2.
Estandarizacion y normalizacion
Estandarizacion
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.
Ventajas
De La Estandarizacion
- Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas.
- Es útil para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.
- Ayuda a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.
- Asegura que el sistema opere correctamente.
- Se utilizan eficientemente los recursos que se dispongan.
Normalización
- Asegúrese de que los estándares sean completos, actualizados, documentados y legibles.
- Auditar permanentemente para que se cumplan los estándares.
- Evaluar si los estándares establecidos son los requeridos y hacer los cambios necesarios para que dichos estándares sean los apropiados.
Teoria
General De Los Manuales De Documentación
Durante 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 dc acuerdo a sus necesidades.
- El estilo de redacción de los manuales de documentación debe ser:
- Concreto.
- Ser preciso y definir los términos utilizados.
- Utilizar párrafos cortos.
- Utilizar títulos y 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 con el número de referencia
Manual De
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.
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.
- Servir como manual de aprendizaje.
- Servir como manual de referencia.
- Definir las funciones que debe realizar el usuario.
- Informar
al usuario de la respuesta a cada mensaje de error.
Pasos a
seguir para definir como desarrollar el manual de usuario.
- Identificar los usuarios del sistema: personal que se relacionará con el sistema.
- Definir los diferentes tipo de usuarios: se presentan los diferentes tipos de usuarios que usarían el sistema. Ejemplo: usuarios directos, indirectos.
- Definir los módulos en que cada usuario participará: Se describen los módulos o procesos que se ejecutarán por cada usuario en forma narrativa breve y clara.
Importancia
Del Manual De Usuario
El Manual
de Usuario facilita el conocimiento de:
Los
documentos a los que se puede dar entrada por computadora.
Los
formatos de los documentos.
Las
operaciones que utiliza de entrada y salida de los datos.
El orden
del tratamiento de la computadora con los datos introducidos.
El momento
en que se debe solicitar una operación deseada.
Los
resultados de las operaciones realizadas a partir de los datos introducidos.
Al
elaborar el Manual de Usuario, hay que tener en cuenta a quién va dirigido es
decir, el manual puede ser manejado desde el director de la empresa hasta el
introductor de datos. Por consiguiente, debe redactarse de forma clara y
sencilla para que lo entienda cualquier tipo de usuario.
No hay comentarios:
Publicar un comentario