Como documentar un plugin
Con el objetivo de migrar la documentación oficial de los plug-ins enterarse a esta plataforma esta es una pequeña guía de como se debe documentar un plug-in
Estructura de la documentacion
Para documentar cualquier plug-in se debe seguir una estructura básica, lo ideal es que todos los...
Introducción
En este apartado se dará una breve resumen del objetivo del plug-in, que hace y para qué sirve. ...
Matriz de compatibilidad
En este apartado pondremos la matriz de compatibilidad, este puede variar en función al tipo de p...
Pre requisitos
En este apartado se definirán todos los requisitos necesarios para que el plug-in funcione, en el...
Configuración
En este apartado definiremos como se debe configurar el plug-in para su ejecución, aquí puede var...
Parámetros generales del plugin
En esta sección se definen los parámetros o las opciones en el fichero de configuración que son o...
Parámetros específicos del plugin
En esta sección describiremos todos los parámetros opcionales del plug-in, si los tiene, todas la...
Ejecución manual
Si no se ha hecho en los dos apartados anteriores se debe describir un ejemplo de la ejecución de...
Configuración en Pandora
Esta sección es importante, hay que describir de la forma más clara posible como se configura el ...
Módulos generados por el plugin
Por último y esta parte es muy importante es documentar el resultado del plug-in definiendo los a...