Creo que lo mas importante a la hora de hacer un manual, es pensar en el indice!!! una vez que tengamos esto echo... practicamente el resto sale solo... Tambien tenes que preguntarte ¿Quien va a leer este manual? osea es Tecnico o no!!!

Si es tencnico... podes adentrarte en aspectos del programa mucho mas profundo... hasta si es de codigo abierto, podes entrar en temas de codigo.

Si simplemente es para un usuario comun... empeza por dar un introductorio a la instalacion del programa, primeras pantallas o pantallas principales, despues podes hacer un ejemplo utilizando el programa como altas y vajas en registros, o lo que maneje tu programa... nunca extendiendote demaciado... siempre lo justo y necesario.

Saludos
MadeInChina

Estos son los pasos del manual del usuario:

1. Portada: De que se trata el documento y quien lo elaboro?
2. Introduccion: Describe el uso del documento(para que sirve?) y de que habla?
3. Analisis y requerimientos del sistema(¿que se ocupa para poder instalarlo y usarlo?)
3. Explicacion del funcionamiento: Debes de poner paso a paso y con pantallas bien explicadas como funciona el programa
4. Glosario

Hay otro manual, pero ese es el manual del programador y para poder hacerlo necesitas el codigo fuente y saber como se elaboro...

Saludos

Esta bien lo que hiciste.. la intension es describir paso a paso para que sirve cada modulo, los tipos de datos que se deben introducir. Por ejemplo yo siempre pongo:

"Para poder imprimir una factura es necesario dar clic en el menu Archivo->Imprimir. Ahi debera especificar el numero de hojas(debera introducir solo numeros) y posteriormete dar clic en el boton imprimir."

Y coloco una captura de la pantalla donde indico y describo cada objeto que esta en el formulario..

Saludos

Si es un manual de usuario podés hacer lo que te dicen los compañeros. Pero si hablás de manual técnico estas hablando de incluír los diagramas de flujo de datos, diccionario de datos, diagrama entidad-relación en caso de usar bases de datos, si usaste la metodología de la programación orientada a objetos entonces debés adicionar el diagrama de clases, casos de uso, etc.

Saludos

Un manual básicamente esta dirigido a personas que no tienen conocimiento alguno del programa que se consulta, por lo tanto puedes seguir un formato clásico pero el lenguaje que debes usar debe ser el más coloquial que se pueda sin llegar a ser demasiado popular; el objetivo es que se entienda con palabras simples c/u de las funciones del programa del cual deseas elaborar el manual, el formato es lo de menos porq te puedes guiar de un formato cualquiera, lo importante es el mensaje y para quien va dirigido

Hola:
Mira yo hace mucho tiempo soy programador, y lo que me ha dado mucho resultado a la hora de editar el manual de un programa ( o archivo de ayuda) es hacer que alguien sin conocimiento profundo del mismo lo opere.
Alli te daras cuenta de los errores que posiblemente cometan los futuros usuarios y te ira dando la pauta de las indicaciones que tienes que volcar en tu manual (errores de ejecucion corregidos, claro).
Es muy comun que el propio programador, por el hecho de conocerlo de memoria como tu dices, no cometa errores, por eso lo bueno de otra persona lo pruebe.
Luego como bien dicen los colegas que me antecedieron con sus mensajes, la estructura del mismo es casi siempre la misma.

estoy tratando de armar este manual, me podrian mostrar con un ejemplo como se realiza este manual. gracias

el manual del programador me refiero. gracias

Hola:

Hice manuales de programación y no me sale nada bien. Hay que tener ideas claras, en mi caso lo hice para el público novel y tipo tutorial. Para que te hagas una idea lo puedes ver aquí.

Manual Visual C# y PIC16F84A con puerto serie

También hice otro bajo PHP, MySQL, APACHE, etc
http://www.abcdatos.com/webmasters/tutorial/v310.html

Saludo.