
¿Qué HACE el programa, para qué sirve?
¿Qué ES el programa?
¿Cómo funciona el programa?
¿Cuales son los conceptos usados por el programa?
¿Cuáles son los temas importantes para el administrador?
¿Qué necesita saber el usuario para usar el programa?
¿Qué otras documentaciones se recomiendan?
¿Qué HACE el programa, para qué sirve?
Describir en forma breve que hace el programa, cuál es su utilidad. Poniendo enlaces a los diferentes conceptos involucrados.
Poner un tema aparte de qué hace el programa, donde la persona que quiere saber qué hace el programa pueda aprenderlo, explicando primero a grandes rasgos de qué se trata el programa y después tratando los diferentes puntos específicos relacionados al programa.
¿Qué ES el programa?
Describir el programa en si, poniendo poco interés aqui en que hace o para que sirve
Explicando cosas como:
En que lenguage esta escrito.
Cuándo se escribió, por quién, dónde.
Dónde se puede conseguir, su información relevante.
Su evolución, quiénes lo usarán, para qué, etc.
¿Cómo funciona el programa?
Aquí se trata de explicar la manera en que el programa hace las cosas pues puede haber muchas formas distintas de obtener un resultado final o de hacer algo.
También se pretende que se usen enlaces a los conceptos involucrados
¿Cuales son los conceptos usados por el programa?
En este lugar que puede ser una página aparte se pretende explicar los diferentes conceptos involucrados en el programa.
La idea es explicar con más detalle lo que significa cada cosa, poniendo ejemplos tipo metáforas que ayuden a recordar y comprender el concepto.
¿Cuáles son los temas importantes para el administrador?
Generalmente existe una persona que instala el programa, lo configura y admistra y se tendra una página separada para los temas relacionados a ese instalador y/o administrador.
Se deben incluir en esa página del administrador, cosas como:
¿Donde conseguir el programa?
¿Qué necesita tener o conseguir antes de instalarlo?
¿Cómo instalarlo?
¿Cómo configurar el programa?
¿Cómo dejarlo listo para que los usuarios o el mismo puedan usarlo?
etc.
¿Qué necesita saber el usuario para usar el programa?
Esto corresponde a lo que acostumbra llamar "manual del usuario" o guía del usuario
Aquí en esta página se pondra lo más importante para el usuario, conteniendo una "guía breve" que será como un compendio, y aparte tendra todo tipo de instrucciones para usar el programa, así como ejemplos, tutoriales y recomendaciones.
¿Qué otras documentaciones se recomiendan?
Poner enlaces a otras páginas que sean pertinentes al programa en si, o a temas relacionados o involucrados.
Leer más...