Documentos de Académico
Documentos de Profesional
Documentos de Cultura
MANUAL TECNICO
Este documento contiene toda la informacin sobre los recursos utilizados por el proyecto, llevan una
descripcin muy bien detallada sobre las caractersticas fsicas y tcnicas de cada elemento. Por
ejemplo: caractersticas de procesadores, velocidad, dimensiones del equipo, garantas, soporte,
proveedores y equipo adicional.
Su extensin depende de la cantidad de recursos y equipo utilizado y generalmente se presenta en
forma de fichas tcnicas en donde se describe en cada una las caractersticas de cada recurso.
CONSIDERACIONES GENERALES PARA LA DOCUMENTACIN DE EL DESARROLLO DE
APLICACIONES INFORMTICAS:
1. Toda documentacin que se genere para un proyecto especfico, que haya sido revisada y aprobada,
debe poseer lo siguiente:
A) Identificacin del documento
Este documento debe incorporar la siguiente informacin:
Logotipo de la organizacin.
Nombre oficial de la organizacin.
Denominacin y extensin. De corresponder a una unidad en particular debe anotarse el nombre de
la misma.
Lugar y fecha de elaboracin.
Nmero de revisin (en su caso).
Unidades responsables de su elaboracin, revisin y/o autorizacin.
Clave de la forma. En primer trmino, las siglas de la organizacin, en segundo lugar las siglas de la
unidad administrativa donde se utiliza la forma y, por ltimo, el nmero de la forma. Entre las siglas y
el nmero debe colocarse un guin 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
efecten durante la etapa de garanta de que lo cubre (si as fuera el caso), el usuario final del sistema
debe recibir una versin actualizada final del documento manual tcnico.
Estructura del documento MANUAL TCNICO
1. ndice
Relacin de los captulos y pginas correspondientes que forman parte del documento
2. Introduccin.
Se debe presentar una breve descripcin del sistema desarrollado, que contemple el mbito abarcado,
cual es su funcin principal y un detalle de las funciones macros o partes que lo componen. Puede
incluir un mensaje de la mxima 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 especficos
Se deben describir brevemente los objetivos especficos que se cumplieron con el desarrollo del sistema.
3. Contenido tcnico
3.1. Definicin 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. Descripcin de campos requeridos por pantalla con presentacin de pantallas.
3.5. Diagrama de navegacin del sistema.
3.6. Requerimientos de interfase con otros sistemas.
3.7. Modelo lgico de datos, diagrama entidad-relacin.
3.8. Modelo de datos fsico, junto con su respectivo diccionario de datos.
3.9. Matriz de procesos versus organizacin.
3.10. Matriz de programas versus entidades.
3.11. Plataforma de usuario. Aqu se describen los requerimientos mnimos 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 aplicacin y/o alcance de los procedimientos. Esfera de accin que cubren los
procedimientos
4. Responsables.
Para iniciar los trabajos que conducen a la integracin de un manual, es indispensable prever que no
queda diluida la responsabilidad de la conduccin de las acciones en diversas personas, sino que debe
designarse a un coordinador, auxiliado por un equipo tcnico, al que se le debe encomendar la
conduccin del proyecto en sus fases de diseo, implantacin y actualizacin. De esta manera se logra
homogeneidad en el contenido y presentacin de la informacin. Por lo que respecta a las
caractersticas del equipo tcnico, es conveniente que sea personal con un buen manejo de las
relaciones humanas y que conozca a la organizacin en lo que concierne a sus objetivos, estructura,
funciones y personal. Para este tipo de trabajo, una organizacin 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 especfica. Asimismo, puede contratar los servicios de
consultores externos.
4.1. Mapa de navegacin. muestra de forma grfica la interconexin entre cada una de las pantallas
del sistema, lo que servira para saber como llegar a determinada parte de la aplicacin. En este se
muestran los mens, submens y pantallas a las que nos lleva cada uno de ellos
4.2. Descripcin grfica del mapa de navegacin. En el anterior aparece de forma de diagrama de
flujo y en esta seccin deber aparecer ya con las respectivas pantallas.
4.3. Describe paso a paso los procesos, as como pantallas, botones, cuadros de texto, etc., pero tambin
se muestra el cdigo de cada rutina, pantalla, botn, etc. es decir, se muestra lo que hay detrs de la
interfaz del usuario
Logotipo de la organizacin.
Nombre oficial de la organizacin.
Denominacin y extensin. De corresponder a una unidad en particular debe anotarse el nombre de
la misma.
Lugar y fecha de elaboracin.
Nmero de revisin (en su caso).
Unidades responsables de su elaboracin, revisin y/o autorizacin.
Clave de la forma. En primer trmino, las siglas de la organizacin, en segundo lugar las siglas de la
unidad administrativa donde se utiliza la forma y, por ltimo, el nmero de la forma. Entre las siglas y
el nmero debe colocarse un guin o diagonal.
B) NDICE O CONTENIDO
Relacin de los captulos y pginas correspondientes que forman parte del documento.
C) PRLOGO Y/O INTRODUCCIN
Exposicin sobre el documento, su contenido, objeto, reas de aplicacin e importancia de su revisin y
actualizacin. Puede incluir un mensaje de la mxima autoridad de las reas comprendidas en el
manual.
D) OBJETIVOS DE LOS PROCEDIMIENTOS
Explicacin del propsito que se pretende cumplir con los procedimientos.
Los objetivos son uniformar y controlar el cumplimiento de las rutinas de trabajo y evitar su alteracin
arbitraria; simplificar la responsabilidad por fallas o errores; facilitar las labores de auditoria; facilitar
las labores de auditoria, la evaluacin 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, adems de otras ventajas adicionales.
E) AREAS DE APLICACIN Y/O ALCANCE DE LOS PROCEDIMIENTOS
Esfera de accin que cubren los procedimientos.
Dentro de la administracin pblica federal los procedimientos han sido clasificados, atendiendo al
mbito de aplicacin 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 OPERACIN
En esta seccin se incluyen los criterios o lineamientos generales de accin que se determinan en forma
explcita para facilitar la cobertura de responsabilidad de las distintas instancias que participaban en
los procedimientos.
Adems debern contemplarse todas las normas de operacin que precisan las situaciones alterativas
que pudiesen presentarse en la operacin de los procedimientos. A continuacin se mencionan algunos
lineamientos que deben considerarse en su planteamiento:
Se definirn perfectamente las polticas y/o normas que circunscriben el marco general de actuacin
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.
Debern ser lo suficientemente explcitas para evitar la continua consulta a los niveles jerrquicos
superiores.
H) CONCEPTO (S)
Palabras o trminos de carcter tcnico que se emplean en el procedimiento, las cuales, por su
significado o grado de especializacin requieren de mayor informacin o ampliacin de su significado,
para hacer ms accesible al usuario la consulta del manual.
I)PROCEDIMIENTO (descripcin de las operaciones). Presentacin por escrito, en forma narrativa y
secuencial, de cada una de las operaciones que se realizan en un procedimiento, explicando en qu
consisten, cundo, cmo, dnde, con qu, y cunto tiempo se hacen, sealando los responsables de
llevarlas a cabo. Cuando la descripcin del procedimiento es general, y por lo mismo comprende varias
reas, debe anotarse la unidad administrativa que tiene a su cargo cada operacin. Si se trata de una
descripcin detallada dentro de una unidad administrativa, tiene que indicarse el puesto responsable
de cada operacin. Es conveniente codificar las operaciones para simplificar su comprensin e
identificacin, aun en los casos de varias opciones en una misma operacin.
J) FORMULARIO DE IMPRESOS. Formas impresas que se utilizan en un procedimiento, las cuales se
intercalan dentro del mismo o se adjuntan como apndices. En la descripcin de las operaciones que
impliquen su uso, debe hacerse referencia especfica de stas, empleando para ello nmeros
indicadores que permitan asociarlas en forma concreta. Tambin se pueden adicionar instructivos para
su llenado.
K) DIAGRAMAS DE FLUJO. Representacin grfica de la sucesin 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 operacin descrita. Adems, suelen hacer mencin del equipo o recursos utilizados en cada caso.
Los diagramas representados en forma sencilla y accesible en el manual, brinda una descripcin clara
de las operaciones, lo que facilita su comprensin. Para este efecto, es aconsejable el empleo de
smbolos y/o grficos simplificados.
L) GLOSARIO DE TRMINOS. Lista de conceptos de carcter tcnico relacionados con el contenido y
tcnicas de elaboracin de los manuales de procedimientos, que sirven de apoyo para su uso o
consulta. Procedimiento general para la elaboracin de manuales administrativos
DISEO DEL PROYECTO. La tarea de preparar manuales administrativos requiere de mucha
precisin , toda vez que los datos tienen que asentarse con la mayor exactitud posible para no generar
confusin en la interpretacin de su contenido por parte de quien los consulta. Es por ello que se debe
poner mucha atencin en todas y cada una de sus etapas de integracin, delineando un proyecto en el
que se consiguen todos los requerimientos, fases y procedimientos que fundamentan la ejecucin del
trabajo.
A) RESPONSABLES
Para iniciar los trabajos que conducen a la integracin de un manual, es indispensable prever que no
queda diluida la responsabilidad de la conduccin de las acciones en diversas personas, sino que debe
designarse a un coordinador, auxiliado por un equipo tcnico, al que se le debe encomendar la
conduccin del proyecto en sus fases de diseo, implantacin y actualizacin. De esta manera se logra
homogeneidad en el contenido y presentacin de la informacin.
Por lo que respecta a las caractersticas del equipo tcnico, es conveniente que sea personal con un
buen manejo de las relaciones humanas y que conozca a la organizacin en lo que concierne a sus
objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organizacin 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) DELIMITACIN DEL UNIVERSO DE ESTUDIO
Los responsables de efectuar los manuales administrativos de una organizacin 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 informacin, 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 informacin sobre los recursos utilizados por el proyecto, llevan una descripcin muy bien
detallada sobre las caractersticas fsicas y tcnicas de cada elemento.
BIBLIOGRAFIAhttp://www.mitecnologico.com/Main/ElaboracionManualTecnico
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 operacin 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 quin 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 informacin y de las actividades que se realizan en
el sistema. Proporciona una visin general del sistema. Representar los diagramas utilizando para ello
diagramas de bloques.
Diagrama particular detallado.
Presentar grficamente todos los pasos que se efecten dentro del departamento usuario a quien est
dirigido este manual. Deben especificarse los archivos de entrada, salida, los resultados, revisiones y
procesos manuales.
Explicacin Genrica De Las Fases Del Sistema
En este punto se explica en forma especfica y detallada todas las operaciones que aparecen
representadas en forma grfica en el diagrama particular. Se analizan cada una de las fases
sealando:
El proceso principal que se desarrolla.
La entrada de la informacin.
La obtencin de un resultado parcial.
El envo de informacin a otra dependencia.
Instalacin Del Sistema
La instalacin del sistema proporciona detalles completos sobre la forma de instalar el sistema en
un ambiente particular.
Iniciacin Al Uso Del Sistema
En este punto se explica cmo iniciarse en el sistema y cmo se pueden utilizar sus cualidades comunes.
Esta documentacin debe decir al usuario cmo 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 volmenes. Los sistemas de ayuda en lnea evitan que el usuario pierda tiempo en consultas
manuales.
Caducidad De Documento Fuente Y Destino Final
Como el usuario trabajar con documentos fuentes, stos podrn tener un perodo de retencin 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
Manuales Administrativos
Concepto:
Son documentos que sirven como medios de comunicacin y coordinacin que permiten registrar y transmitir en
forma ordenada y sistemtica, informacin de una organizacin (antecedentes, legislacin, estructura, objetivos,
polticas, sistemas, procedimientos, etc.). As como las instrucciones y lineamientos que se consideren necesarios
para el mejor desempeo de sus tareas.
Coadyuvar a la correcta realizacin de las labores encomendadas al personal y propiciar la uniformidad del trabajo.
Ahorrar tiempo y esfuerzo en la realizacin del trabajo, evitando la repeticin de instrucciones y directrices.
Agilizar el estudio de la organizacin.
Facilitar el reclutamiento, seleccin e integracin de personal.
Sistematizar la iniciativa, aprobacin, publicacin y aplicacin de las modificaciones necesarias en la organizacin.
Determinar las responsabilidades de cada unidad y puesto en relacin con el resto de la organizacin.
Establecer claramente el grado de autoridad y responsabilidad de los distintos niveles jerrquicos que lo componen.
Promover el aprovechamiento racional de los recursos humanos, materiales, financieros y tecnolgicos disponibles.
Funcionar como medio de relacin y coordinacin con otras organizaciones.
Servir como vehculo de orientacin e informacin a los proveedores de bienes, prestadores de servicios y usuarios
o clientes con los que interacta la organizacin.
Limitaciones:
Constituyen una herramienta, pero no la solucin para todos los problemas administrativos que se puedan
presentar.
Si no se actualizan permanentemente, pierden vigencia con rapidez.
Incluyen solo los aspectos formales de la organizacin dejando de lado los informales, cuya vigencia e importancia
para la vida de la misma es notoria.
Muchas compaas consideran que son demasiado pequeas para necesitar un manual que describa asuntos que
son conocidos por todos los integrantes.
Algunas consideran que son demasiado caro, limitativo y laborioso preparar un manual y conservarlo al da.
Existe el temor de que pueda conducir a una estricta reglamentacin y rigidez.
Estructura de un Manual
Las partes principales de un manual pueden ser las siguientes:
Tabla de contenido
Introduccin
Instrucciones para el uso del manual
Cuerpo del manual
Flujogramas
Glosario de trminos
Conclusiones
Recomendaciones
Anexos
Importancia de los manuales
La importancia de los manuales radica en que ellos explican de manera detallada los procedimientos dentro de una
organizacin; a travs de ellos logramos evitar grandes errores que se suelen cometer dentro de las reas
funcionales de la empresa. Estos pueden detectar fallas que se presentan con regularidad, evitando la duplicidad de
funciones. Adems son de gran utilidad cuando ingresan nuevas personas a la organizacin ya que le explican todo
lo relacionado con la misma, desde su resea histrica, haciendo referencia a su estructura organizacional, hasta
explicar los procedimientos y tareas de determinado departamento.
LINKS DE MANUALES
Aqu mando unos links para que puedan ver en lnea los 3 diferentes manuales:
http://es.scribd.com/doc/18933257/Manual-de-Usuario-Ejemplo
MANUAL TECNICO
MANUAL DE USUARIO
http://sabus.usal.es/pdf/manual_ref.pdf
MANUAL ADMINISTRATIVO
http://www.consejeria.df.gob.mx/contenidos/justiciaCivica/documentos/Guia_Manuales_Administrativos.pdf