Procedimiento de Elaboración de Manuales de Usuarios del Sistema
Regresar a Proceso de Producción de Documentos
Identificación
|
Nombre | Código | 
| |
| Manual Elaboración de Manuales de Usuarios del Sistema | PGD1D | |||
| Fecha de Emisión | Fecha de Actualización | Versión | ||
|
2013/01/25 |
2020-02-10 |
4 | ||
Elaboró: Lucy Ramirez L
Revisó y Autorizo Ultima Versión: Comité de Calidad
Introducción
Oncomedic ha sido un comprometido con el desarrollo de soluciones tecnológicas con el uso de software libre en sistemas operativo linux a participado en el desarrollo e implementación de los sistemas oncolinux 1, GaleNUx y oncolinux 2.
La creación de dichas herramientas ha sido producto de un gran esfuerzo de la dirección, junto con un equipo humano, desarrolladores de sistemas y profesionales de la salud que han buscado integrar la ciencia y la tecnología en pro de los usuarios y de la misma organización.
Un nuevo reto se erige para Oncomedic y sus funcionarios y es la documentación del que hacer del sistema con el objetivo de lograr un mejor uso del mismo se hace necesario la implementación y socialización de los manuales de uso de los software usados en la organización en una forma ordenada, concisa y precisa que permita dar continuidad y solidez a los procesos de sistematización de la atención, por eso este manual que permite dar los lineamientos generales que se deben seguir a la hora de elaborar el manual de usuarios del sistema en sus diferentes procesos.
Objetivo del Manual.
Describir los lineamientos técnicos procedimentales de elaboración del manual de usuarios al sistema, que permita mostrar al usuario de una manera rápida y eficaz como hacer su trabajo cotidiano con el software, desglosando el procedimiento paso a paso, en forma organizada, concisa, comprensiva y aportar las soluciones a los problemas que puedan suceder en la operación
Alcance
Este manual incluye todas las fases de elaboración de los manuales de uso de los software en oncomedic ltda, desde su fase de planeación hasta su redacción final, que luego se articula a los procesos organizacionales de aprobación y difusión de los documentos
Descripción de los Procedimientos
Solucitud de Elaboración del Manual de usuarios al Sistema Operativo
El comité de calidad o el coordinador de calidad delega as una persona o grupo de personas para el desarrollo del procedimiento.
Planeación
Evaluación de los Requerimientos
Antes de escribir el manual realice una evaluación de las características que debe cumplir el manual
- Requisitos del producto: Que características fundamentales debe cumplir el proceso que se esta documentando
- Perfil del usuario: características particulares de la persona a la que va dirigida el manual, profesión, nivel de escolaridad, roles en el ambiente de trabajo, experiencia
- Conceptos claves: Que necesita saber el usuario de cada manual, para ello identifique que se pretende lograr con cada manual, formas en que se facilita el que hacer del funcionario, que puntos son fundamentales o requieren atención especial.
- Tareas que realiza en el sistema: Registre los flujos de las tareas y redactelas con la mayor sencillez y precisión posible, revise que tareas no están automatizadas dentro del software pues esto puede constituir una oportunidad de mejora del sistema, organice las tareas según secuencias de significado (Cronológico o Funcional)
- Cosidere los problemas potenciales y soluciones
Enfoque Descriptivo
Es muy importante establecer de acuerdo a las características anteriormente descritas el enfoque de descripción de uso mas apropiado que permita un diseño funcional
- Enfoque de redacción: Enuncia en prosa las actividades a realizar
- Enfoque visual : Mediante capturas de pantallasos se hace conocer el funcionamiento del sistema.
- Enfoque especial: Busca otras alternativas para evidenciar el manejo del sistema
Redacción
Tomando en cuenta los datos anteriormente recolectados se define la estructura del manual, precise los temas a tratar, desde la introducción hasta los últimos consejos buscando ser conciso facilitando el uso del manual.
Al momento de escribir prefiera titulos con significado que aporten valor y orienten respecto a lo que esta escribiendo, se deben seguir los lineamiento generales de redacción, es recomendable que el manual contega los siguientes capitulos:
- Índice
- Introducción Acerca del Manual: Realizar descripción del sistema, como funciona, para que es, quien lo puede utilizar
- Objetivo: Propósito del proceso sistematizado que se esta documentando
- Alcance: Acotar el alcance o profundidad del manual, para delimitar el manual de modo que no se extralimite o sea demasiado breve.
- Usuario: Permite adaptar el lenguaje utilizado en el manual a las características del usuario.
- Glosario de terminología y conceptos claves
- Presentación visual al software que describa la interfase del usuario
- Descripción del procedimientos: Dar instrucciones paso a paso, numeradas, usando verbos imperativos, para pasos similares use la misma frase, haga diferencia entre las instrucciones y explicaciones adicionales
- Sección de comandos
- Generación de reportes y consultas si es necesario
- Resolución de problemas anticipece a los errores y problemas que pueden presentarse en la cotidianidad del uso del software e enuncian los problemas las dudas mas comunes y las posibles soluciones
Revisión Preliminar
Luego de redacta el manual, tomando en cuenta todo lo anterior, páselo a diferentes personas que se ajusten al público objetivo, a ver si entienden bien el contenido, y tome sus recomendaciones, para elaborar así una versión final.
Luego de lo cual debe seguir el procesos de aprobación del manual
Cuadro de Procedimiento
|
Nombre del Procedimiento. |
Elaboración de manuales de usuarios del sistema operativo |
|
Objetivo del Procedimiento |
Describir los lineamientos técnicos procedimentales de elaboración del manual de usuarios al sistema, que permita mostrar al usuario de una manera rápida y eficaz como hacer su trabajo cotidiano con el software, desglosando el procedimiento paso a paso, en forma organizada, concisa, comprensiva y aportar las soluciones a los problemas que puedan suceder en la operación |
|
Responsable |
Coordinador de cada proceso a documentar |
|
Alcance |
Todas las fases de elaboración de los manuales de uso de los software en oncomedic ltda, desde su fase de planeación hasta su redacción final, que luego se articula a los procesos organizacionales de aprobación y difusión de los documentos |
|
Requisitos Generales de Operación del Procedimiento |
|
| Pasos |
|
Diagrama de Flujo
Referencias
Barker, Thomas. Writing sofware documentation, a Task-Oriented Aprroach. Allyn&Bancon, USA 1998
Hargis, Gretchen. Developing Quality Tecchnical Informatión, A Handbook for writer and Editors prentice hall, IBM, USA, 1998