Skip to main content

Estructura de la documentacion

Para documentar cualquier plug-in se debe seguir una estructura básica, lo ideal es que todos los plug-in contaran con la misma estructura para dar la sensación de familiaridad y homogeneidad al usuario.

Sabemos que casa plug-in tiene su comportamiento y no todos se configuran de la misma forma, pero intentaremos hacerlos lo  más homogéneos posible.

La estructura de la documentación seria:

  • Introducción 
  • Matriz de compatibilidad 
  • Prerrequisitos 
  • Configuración 
  • Configuraciones generales del plugin 
  • Configuraciones específicas 
  • Ejecución manual 
  • Configuración en Pandora 
  • Módulos generados por el plugin

Describiremos casa sección a lo largo de de este documento.