Guidelines: Documentation

From Pandora FMS Wiki
Jump to: navigation, search

Como hacer documentación de usuario

Toda documentación de usuario tiene que seguir estos principios básicos:

  1. . Introducción: ¿Esto que es?, ¿para qué sirve?.
  2. . Instalación. Qué necesitas para instalar. Cómo lo instalas, como lo configuras por primera vez.
  3. . Uso: Pasos basicos, ejemplos, capturas y descripcion de algunas opciones "chungas".

Normas generales:

  • NO contar cosas que el usuario puede leer. En general ¿que sentido tiene explicar aquello que ya viene explicado en la propia interfaz?, ¿tiene sentido enumerar las opciones de un menu?. No. No tiene sentido, lo que habra que explicar es aquello que no es obvio.
  • Explicar con ejemplos: Es la mejor forma de explicar algo cuando es complicado.
  • Poner capturas: A veces ¿Que mejor ejemplo que una captura?.
  • No extenderse más allá de lo estrictamente necesario. No usar expresiones complejas. No usar frases largas. Usar palabras sencillas. Cuando mas corto, conciso, concreto y sintética sea una documentación: Mucho mejor.