MAYTÉ PAULINA MÉNDEZ ÁVILA
ANALISTA DE SISTEMAS DE INFORMACION
TAREA4
MANUAL TECNICO
Este documento contiene toda la información sobre los recursos utilizados por el proyecto, llevan una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento. Por ejemplo: características de procesadores, velocidad, dimensiones del equipo, garantías, soporte, proveedores y equipo adicional.
Su extensión depende de la cantidad de recursos y equipo utilizado y generalmente se presenta en forma de fichas técnicas en donde se describe en cada una las características de cada recurso.
CONSIDERACIONES GENERALES PARA LA DOCUMENTACIÓN DE EL DESARROLLO DE APLICACIONES INFORMÁTICAS:
1. Toda documentación que se genere para un proyecto específico, que haya sido revisada y aprobada, debe poseer lo siguiente:
A) Identificación del documento
Este documento debe incorporar la siguiente información:
• Logotipo de la organización.
• Nombre oficial de la organización.
• Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma.
• Lugar y fecha de elaboración.
• Número de revisión (en su caso).
• Unidades responsables de su elaboración, revisión y/o autorización.
• Clave de la forma. En primer término, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por último, el número de la forma. Entre las siglas y el número debe colocarse un guión o diagonal. (en su caso)
B) Estructura del documento.
2. Por cada documento final deberá entregarse copias al personal involucrado en el proyecto.
3. Una vez concluido el desarrollo de un sistema, considerando para esto los posibles cambios que se efectúen durante la etapa de garantía de que lo cubre (si así fuera el caso), el usuario final del sistema debe recibir una versión actualizada final del documento manual técnico.
Estructura del documento MANUAL TÉCNICO
1. Índice
Relación de los capítulos y páginas correspondientes que forman parte del documento
2. Introducción.
Se debe presentar una breve descripción del sistema desarrollado, que contemple el ámbito abarcado, cual es su función principal y un detalle de las funciones macros o partes que lo componen. Puede incluir un mensaje de la máxima autoridad de las áreas comprendidas en el manual.
2.1. Objetivo general del sistema
Se debe de describir el objetivo general del sistema.
2.2. Objetivos específicos
Se deben describir brevemente los objetivos específicos que se cumplieron con el desarrollo del sistema.
3. Contenido técnico
3.1. Definición de reglas del negocio implementadas en el sistema desarrollado.
3.2. Diagramas de flujo de datos, junto con su respectivo diccionario de datos.
3.3. Controles de auditoria implementados en el sistema.
3.4. Descripción de campos requeridos por pantalla con presentación de pantallas.
3.5. Diagrama de navegación del sistema.
3.6. Requerimientos de interfase con otros sistemas.
3.7. Modelo lógico de datos, diagrama entidad-relación.
3.8. Modelo de datos físico, junto con su respectivo diccionario de datos.
3.9. Matriz de procesos versus organización.
3.10. Matriz de programas versus entidades.
3.11. Plataforma de usuario. Aquí se describen los requerimientos mínimos que se deben tener tanto de hardware como de software para que el sistema se pueda instalar y ejecutar correctamente (en caso de que se considere necesario).
3.12. Áreas de aplicación y/o alcance de los procedimientos. Esfera de acción que cubren los procedimientos
4. Responsables.
Para iniciar los trabajos que conducen a la integración de un manual, es indispensable prever que no queda diluida la responsabilidad de la conducción de las acciones en diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo técnico, al que se le debe encomendar la conducción del proyecto en sus fases de diseño, implantación y actualización. De esta manera se logra homogeneidad en el contenido y presentación de la información. Por lo que respecta a las características del equipo técnico, es conveniente que sea personal con un buen manejo de las relaciones humanas y que conozca a la organización en lo que concierne a sus objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organización puede nombrar a la persona que tenga los conocimientos y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede encargarlo al titular de el área específica. Asimismo, puede contratar los servicios de consultores externos.
4.1. Mapa de navegación. muestra de forma gráfica la interconexión entre cada una de las pantallas del sistema, lo que serviría para saber como llegar a determinada parte de la aplicación. En este se muestran los menús, submenús y pantallas a las que nos lleva cada uno de ellos
4.2. Descripción gráfica del mapa de navegación. En el anterior aparece de forma de diagrama de flujo y en esta sección deberá aparecer ya con las respectivas pantallas.
4.3. Describe paso a paso los procesos, así como pantallas, botones, cuadros de texto, etc., pero también se muestra el código de cada rutina, pantalla, botón, etc. es decir, se muestra lo que hay detrás de la interfaz del usuario
Logotipo de la organización.
· Nombre oficial de la organización.
· Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma.
· Lugar y fecha de elaboración.
· Nùmero de revisión (en su caso).
· Unidades responsables de su elaboración, revisión y/o autorización.
· Clave de la forma. En primer tèrmino, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por ùltimo, el nùmero de la forma. Entre las siglas y el nùmero debe colocarse un guiòn o diagonal.
B) ÍNDICE O CONTENIDO
Relación de los capítulos y pàginas correspondientes que forman parte del documento.
C) PRÒLOGO Y/O INTRODUCCIÓN
Exposición sobre el documento, su contenido, objeto, àreas de aplicación e importancia de su revisión y actualizaciòn. Puede incluir un mensaje de la máxima autoridad de las àreas comprendidas en el manual.
D) OBJETIVOS DE LOS PROCEDIMIENTOS
Explicación del propósito que se pretende cumplir con los procedimientos.
Los objetivos son uniformar y controlar el cumplimiento de las rutinas de trabajo y evitar su alteración arbitraria; simplificar la responsabilidad por fallas o errores; facilitar las labores de auditoria; facilitar las labores de auditoria, la evaluación del control interno y su vigilancia; que tanto los empleados como sus jefes conozcan si el trabajo se está realizando adecuadamente; reducir los costos al aumentar la eficiencia general, además de otras ventajas adicionales.
E) AREAS DE APLICACIÓN Y/O ALCANCE DE LOS PROCEDIMIENTOS
Esfera de acción que cubren los procedimientos.
Dentro de la administración pública federal los procedimientos han sido clasificados, atendiendo al ámbito de aplicación y a
sus alcances, en: procedimientos macroadministrativos y procedimientos mesoadministrativos o sectoriales.
F) RESPONSABLES
Unidades administrativas y/o puestos que intervienen en los procedimientos en cualquiera de sus fases
G) NORMAS DE OPERACIÓN
En esta sección se incluyen los criterios o lineamientos generales de acción que se determinan en forma explícita para facilitar la cobertura de responsabilidad de las distintas instancias que participaban en los procedimientos.
Además deberán contemplarse todas las normas de operación que precisan las situaciones alterativas que pudiesen presentarse en la operación de los procedimientos. A continuación se mencionan algunos lineamientos que deben considerarse en su planteamiento:
· Se definirán perfectamente las políticas y/o normas que circunscriben el marco general de actuación del personal, a efecto de que esté no incurra en fallas.
· Los lineamientos se elaboran clara y concisamente, a fin de que sean comprendidos incluso por personas no familiarizadas con los aspectos administrativos o con el procedimiento mismo.
· Deberán ser lo suficientemente explícitas para evitar la continua consulta a los niveles jerárquicos superiores.
H) CONCEPTO (S)
Palabras o términos de carácter técnico que se emplean en el procedimiento, las cuales, por su significado o grado de especialización requieren de mayor información o ampliación de su significado, para hacer más accesible al usuario la consulta del manual.
I)PROCEDIMIENTO (descripción de las operaciones). Presentación por escrito, en forma narrativa y secuencial, de cada una de las operaciones que se realizan en un procedimiento, explicando en qué consisten, cuándo, cómo, dónde, con qué, y cuánto tiempo se hacen, señalando los responsables de llevarlas a cabo. Cuando la descripción del procedimiento es general, y por lo mismo comprende varias áreas, debe anotarse la unidad administrativa que tiene a su cargo cada operación. Si se trata de una descripción detallada dentro de una unidad administrativa, tiene que indicarse el puesto responsable de cada operación. Es conveniente codificar las operaciones para simplificar su comprensión e identificación, aun en los casos de varias opciones en una misma operación.
J) FORMULARIO DE IMPRESOS. Formas impresas que se utilizan en un procedimiento, las cuales se intercalan dentro del mismo o se adjuntan como apéndices. En la descripción de las operaciones que impliquen su uso, debe hacerse referencia específica de éstas, empleando para ello números indicadores que permitan asociarlas en forma concreta. También se pueden adicionar instructivos para su llenado.
K) DIAGRAMAS DE FLUJO. Representación gráfica de la sucesión en que se realizan las operaciones de un procedimiento y/o el recorrido de formas o materiales, en donde se muestran las unidades administrativas (procedimiento general), o los puestos que intervienen (procedimiento detallado), en cada operación descrita. Además, suelen hacer mención del equipo o recursos utilizados en cada caso. Los diagramas representados en forma sencilla y accesible en el manual, brinda una descripción clara de las operaciones, lo que facilita su comprensión. Para este efecto, es aconsejable el empleo de símbolos y/o gráficos simplificados.
L) GLOSARIO DE TÉRMINOS. Lista de conceptos de carácter técnico relacionados con el contenido y técnicas de elaboración de los manuales de procedimientos, que sirven de apoyo para su uso o consulta. Procedimiento general para la elaboración de manuales administrativos
DISEÑO DEL PROYECTO. La tarea de preparar manuales administrativos requiere de mucha precisión , toda vez que los datos tienen que asentarse con la mayor exactitud posible para no generar confusión en la interpretación de su contenido por parte de quien los consulta. Es por ello que se debe poner mucha atención en todas y cada una de sus etapas de integración, delineando un proyecto en el que se consiguen todos los requerimientos, fases y procedimientos que fundamentan la ejecución del trabajo.
A) RESPONSABLES
Para iniciar los trabajos que conducen a la integración de un manual, es indispensable prever que no queda diluida la responsabilidad de la conducción de las acciones en diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo técnico, al que se le debe encomendar la conducción del proyecto en sus fases de diseño, implantación y actualización. De esta manera se logra homogeneidad en el contenido y presentación de la información.
Por lo que respecta a las características del equipo técnico, es conveniente que sea personal con un buen manejo de las relaciones humanas y que conozca a la organización en lo que concierne a sus objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organización puede nombrar a la persona que tenga los conocimientos y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede encargarlo al titular de la unidad de mejoramiento administrativo (en caso de contar con este mecanismo). Asimismo, puede contratar los servicios de consultores externos.
B) DELIMITACIÓN DEL UNIVERSO DE ESTUDIO
Los responsables de efectuar los manuales administrativos de una organización tienen que definir y delimitar su universo de trabajo para estar en posibilidad de actuar en él; para ello, deben realizar:
ESTUDIO PRELIMINAR
Este paso es indispensable para conocer en forma global las funciones y actividades que se realizan en el área o áreas donde se va a actuar. Con base en él se puede definir la estrategia global para el levantamiento de información, identificando las fuentes de la misma, actividades por realizar, magnitud y alcances del proyecto, instrumentos requeridos para el trabajo y en general, prever las acciones y estimar los recursos necesarios para efectuar el estudio.
CONCLUSION: El manual tecnico es el manual que utiliza el programador, este documento contiene toda la información sobre los recursos utilizados por el proyecto, llevan una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento.
· Nombre oficial de la organización.
· Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma.
· Lugar y fecha de elaboración.
· Nùmero de revisión (en su caso).
· Unidades responsables de su elaboración, revisión y/o autorización.
· Clave de la forma. En primer tèrmino, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por ùltimo, el nùmero de la forma. Entre las siglas y el nùmero debe colocarse un guiòn o diagonal.
B) ÍNDICE O CONTENIDO
Relación de los capítulos y pàginas correspondientes que forman parte del documento.
C) PRÒLOGO Y/O INTRODUCCIÓN
Exposición sobre el documento, su contenido, objeto, àreas de aplicación e importancia de su revisión y actualizaciòn. Puede incluir un mensaje de la máxima autoridad de las àreas comprendidas en el manual.
D) OBJETIVOS DE LOS PROCEDIMIENTOS
Explicación del propósito que se pretende cumplir con los procedimientos.
Los objetivos son uniformar y controlar el cumplimiento de las rutinas de trabajo y evitar su alteración arbitraria; simplificar la responsabilidad por fallas o errores; facilitar las labores de auditoria; facilitar las labores de auditoria, la evaluación del control interno y su vigilancia; que tanto los empleados como sus jefes conozcan si el trabajo se está realizando adecuadamente; reducir los costos al aumentar la eficiencia general, además de otras ventajas adicionales.
E) AREAS DE APLICACIÓN Y/O ALCANCE DE LOS PROCEDIMIENTOS
Esfera de acción que cubren los procedimientos.
Dentro de la administración pública federal los procedimientos han sido clasificados, atendiendo al ámbito de aplicación y a
sus alcances, en: procedimientos macroadministrativos y procedimientos mesoadministrativos o sectoriales.
F) RESPONSABLES
Unidades administrativas y/o puestos que intervienen en los procedimientos en cualquiera de sus fases
G) NORMAS DE OPERACIÓN
En esta sección se incluyen los criterios o lineamientos generales de acción que se determinan en forma explícita para facilitar la cobertura de responsabilidad de las distintas instancias que participaban en los procedimientos.
Además deberán contemplarse todas las normas de operación que precisan las situaciones alterativas que pudiesen presentarse en la operación de los procedimientos. A continuación se mencionan algunos lineamientos que deben considerarse en su planteamiento:
· Se definirán perfectamente las políticas y/o normas que circunscriben el marco general de actuación del personal, a efecto de que esté no incurra en fallas.
· Los lineamientos se elaboran clara y concisamente, a fin de que sean comprendidos incluso por personas no familiarizadas con los aspectos administrativos o con el procedimiento mismo.
· Deberán ser lo suficientemente explícitas para evitar la continua consulta a los niveles jerárquicos superiores.
H) CONCEPTO (S)
Palabras o términos de carácter técnico que se emplean en el procedimiento, las cuales, por su significado o grado de especialización requieren de mayor información o ampliación de su significado, para hacer más accesible al usuario la consulta del manual.
I)PROCEDIMIENTO (descripción de las operaciones). Presentación por escrito, en forma narrativa y secuencial, de cada una de las operaciones que se realizan en un procedimiento, explicando en qué consisten, cuándo, cómo, dónde, con qué, y cuánto tiempo se hacen, señalando los responsables de llevarlas a cabo. Cuando la descripción del procedimiento es general, y por lo mismo comprende varias áreas, debe anotarse la unidad administrativa que tiene a su cargo cada operación. Si se trata de una descripción detallada dentro de una unidad administrativa, tiene que indicarse el puesto responsable de cada operación. Es conveniente codificar las operaciones para simplificar su comprensión e identificación, aun en los casos de varias opciones en una misma operación.
J) FORMULARIO DE IMPRESOS. Formas impresas que se utilizan en un procedimiento, las cuales se intercalan dentro del mismo o se adjuntan como apéndices. En la descripción de las operaciones que impliquen su uso, debe hacerse referencia específica de éstas, empleando para ello números indicadores que permitan asociarlas en forma concreta. También se pueden adicionar instructivos para su llenado.
K) DIAGRAMAS DE FLUJO. Representación gráfica de la sucesión en que se realizan las operaciones de un procedimiento y/o el recorrido de formas o materiales, en donde se muestran las unidades administrativas (procedimiento general), o los puestos que intervienen (procedimiento detallado), en cada operación descrita. Además, suelen hacer mención del equipo o recursos utilizados en cada caso. Los diagramas representados en forma sencilla y accesible en el manual, brinda una descripción clara de las operaciones, lo que facilita su comprensión. Para este efecto, es aconsejable el empleo de símbolos y/o gráficos simplificados.
L) GLOSARIO DE TÉRMINOS. Lista de conceptos de carácter técnico relacionados con el contenido y técnicas de elaboración de los manuales de procedimientos, que sirven de apoyo para su uso o consulta. Procedimiento general para la elaboración de manuales administrativos
DISEÑO DEL PROYECTO. La tarea de preparar manuales administrativos requiere de mucha precisión , toda vez que los datos tienen que asentarse con la mayor exactitud posible para no generar confusión en la interpretación de su contenido por parte de quien los consulta. Es por ello que se debe poner mucha atención en todas y cada una de sus etapas de integración, delineando un proyecto en el que se consiguen todos los requerimientos, fases y procedimientos que fundamentan la ejecución del trabajo.
A) RESPONSABLES
Para iniciar los trabajos que conducen a la integración de un manual, es indispensable prever que no queda diluida la responsabilidad de la conducción de las acciones en diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo técnico, al que se le debe encomendar la conducción del proyecto en sus fases de diseño, implantación y actualización. De esta manera se logra homogeneidad en el contenido y presentación de la información.
Por lo que respecta a las características del equipo técnico, es conveniente que sea personal con un buen manejo de las relaciones humanas y que conozca a la organización en lo que concierne a sus objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organización puede nombrar a la persona que tenga los conocimientos y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede encargarlo al titular de la unidad de mejoramiento administrativo (en caso de contar con este mecanismo). Asimismo, puede contratar los servicios de consultores externos.
B) DELIMITACIÓN DEL UNIVERSO DE ESTUDIO
Los responsables de efectuar los manuales administrativos de una organización tienen que definir y delimitar su universo de trabajo para estar en posibilidad de actuar en él; para ello, deben realizar:
ESTUDIO PRELIMINAR
Este paso es indispensable para conocer en forma global las funciones y actividades que se realizan en el área o áreas donde se va a actuar. Con base en él se puede definir la estrategia global para el levantamiento de información, identificando las fuentes de la misma, actividades por realizar, magnitud y alcances del proyecto, instrumentos requeridos para el trabajo y en general, prever las acciones y estimar los recursos necesarios para efectuar el estudio.
CONCLUSION: El manual tecnico es el manual que utiliza el programador, este documento contiene toda la información sobre los recursos utilizados por el proyecto, llevan una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento.
MAYTÉ PAULINA MÉNDEZ ÁVILA
ANALISTA DE SISTEMAS DE INFORMACION
TAREA4
MANUAL DE USUARIO
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.
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.
Contenido
Diagrama general del sistema
Muestra en forma condensada el flujo general de la información y de las actividades que se realizan en el sistema. Proporciona 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 especificarse los archivos de entrada, salida, los resultados, revisiones y procesos manuales.
Explicación Genérica De Las Fases Del Sistema
En este punto se explica en forma específica y detallada todas las operaciones que aparecen representadas en forma gráfica en el diagrama particular. Se analizan cada una de las fases señalando:
El proceso principal que se desarrolla.
La entrada de la información.
La obtención de un resultado parcial.
El envío de información a otra dependencia.
La entrada de la información.
La obtención de un resultado parcial.
El envío de información a otra dependencia.
Instalación Del Sistema
La instalación del sistema proporciona detalles completos sobre la forma de instalar el sistema en un ambiente particular.
Iniciación Al Uso Del Sistema
En este punto se explica cómo iniciarse en el sistema y cómo se pueden utilizar sus cualidades comunes. Esta documentación debe decir al usuario cómo salir de un problema cuando las cosas funcionan mal.
Manual De Referencia
Es el documento definitivo de cara al usuario y debe ser completo. Describe con detalle las cualidades del sistema y su uso, los informes de error generados y las situaciones en que surgen esos errores.
Dependiendo del sistema, los documentos al usuario se pueden proporcionar por separado o reunidos en varios volúmenes. Los sistemas de ayuda en línea evitan que el usuario pierda tiempo en consultas manuales.
Caducidad De Documento Fuente Y Destino Final
Como el usuario trabajará con documentos fuentes, éstos podrán tener un período de retención y un destino especificado.
CONCLUSION:
Este manual es el que utiliza el usuario, el cliente es el que utiliza y puede ver todos los procesos.
CONCLUSION:
Este manual es el que utiliza el usuario, el cliente es el que utiliza y puede ver todos los procesos.
BIBLIOGRAFIA:
grasias por la informacion
ResponderEliminarmuchas gracias por tu publicación me ayudo mucho y tienes un acomodo de la información muy bueno.
ResponderEliminar