Como Elaborar Manual de un Sistema - VB-MUNDO

Claudia · #1 (**permalink**) 27-04-2005, 17:44:48

Hola a todos, alguien tiene mas o menos la idea de como puedo elaborar un manual de mi sistema es que no se por donde emprezar y temo que si comienzo a escribir termine quizas de explicar cosas que al usuario no le interese me pueden ayudar por fa quiero tener mas o menos la idea de que poner es k no se k hacer ayudenme por fa :smt009

acalanto · #2 (**permalink**) 27-04-2005, 18:50:07

Me parece que pocos usuario podrán responder a una pregunta tan general al mismo tiempo que tan específica de una aplicación concreta.

Creo que puedes coger buenas ideas de manuales ya escritos (Microsoft Office por ejemplo).

Inicialmente creo que debes hacer una introducción de las caracerísticas de la aplicación, para que sirve, que pretende resolver y a quién va dirigida, así como las características de equipos para que se instale y funcione correctamente.

Si tiene un instalador, descríbelo e indica los pasos correctos para hacer una instalación sin problemas; Enumera los posible problemas con los que se pueda encontrar el usuario, su causa más probable y a ser posible la solución.

Acto seguido puedes dividir el manual en

Mantenimiento de ficheros (Procesos Iniciales)
Trabajar con la aplicación (Procesos diarios)
Informes, listados y exportaciones (Trabajos periódicos)
Herramientas auxiliares (Backup, configuraciones etc).
Por último algunos consejos al usuario de todas aquellas cosas que debe tener en cuenta y aquellas que no ddebe hacer (Desconectar el equipo, formatear el disco duro etc).

Todo ello apoyado con un índice inicial por capítulos y un temático al final y naturalmente procurando seguir la misma lógica del propio menú o barras de herramientas de la aplicación. Obseerva y analiza la secuencia de acciones de un usuario en todo un periodo y trata de ponerlo en el mismo orden.

Lógicamente pon todo tipo de pantallas, esquemas y gráficos que puean ayudar a comprender situaciones y comportamientos concretos de la aplicación.

No se me ocurre nada más que decirte que lo mejor es que te sientes unas horas para diseñar un borrador del documento y -cuando lo tengas más o menos estudiado- comienza a redactar y a ponerlo en 'bonito'.

Comprenderás que al desconocer la naturaleza de la aplicación es poco probable que se te pueda ayudar más sobre este tema.....

Espero que todo este rollo te resulte útil.

Ronald_Leon_Madrid · #3 (**permalink**) 27-04-2005, 20:11:25

Hola Claudia :

que tal un gusto en saludarte, dejame decirte que existe un gran manuel que se llama Doc To Help 7.5 de ComponentOne, esta aplicación te genera el archivo chm, html, doc, pdf, entre otros, es fabuloso y el mejor que hay.

Saludos cordiales,

Claudia · #4 (**permalink**) 27-04-2005, 20:37:51

Gracias por las Respuestas , vos a seguir tus consejos Acalanto al menos ya tengo la idea de la estructura que debo mas o menos seguir es dificil para mi por k es la primera vez que hago esto :smt009