Documentacion Bizagui

[ocultar]

• 1 Plantilla Funcional

o 1.1 1. Información General

o 1.2 2. Características

o 1.3 3. Actividades

o 1.4 4. Configuración y Requisitos

o 1.5 5. Casos especiales, excepciones

o 1.6 6. Interacción con otros módulos de Bizagi

Todo proceso de documentación responde a la necesidad de un usuario de llenar un vacio de conocimiento en un área determinada.

El usuario final (experto o inexperto) en su interacción con Bizagi espera encontrar en la documentación una solución pertinente a sus inquietudes y a los problemas que se le puedan presentar. La inquietud básica del usuario es: ¿Cómo uso esta funcionalidad, este programa?

Antes de empezar a escribir o documentar alguna funcionalidad de Bizagi debemos plantearnos la solución a esa pregunta básica, para describir de una forma organizada y coherente la información que va quedar definida en cada artículo de BizagiWiki.

Si generamos una documentación organizada, clara y completa, evitamos procesos de repetición de información, ahorramos tiempo de este tipo de actividades y a traves del manual brindamos apoyo a temas de soporte, capacitación para usuarios externos o internos.

La siguiente plantilla es una guía para documentar y organizar la información de una funcionalidad en un artículo de BizagiWiki. Igualmente puede apoyarse en los documentos Manual de Uso BizagiWiKI y Mejores Prácticas Documentación para estructurar los contenidos de BizagiWiki.

• 1.1. Nombre de la funcionalidad.

• 1.2. Resumen.

• 2.1. Contexto. Describe el contexto y el origen de la funcionalidad.Por ejemplo, puede identificar los objetivos de negocio que suple o los problemas solucionados con la implementación.

• 2.2. Descripción de la funcionalidad. Puede contener ejemplos cuando la complejidad así lo requiera.

• 3.1. BizagiStudio. Contiene los pasos que se deben llevar a cabo para configurar la funcionalidad o utilizarla dentro de BizagiStudio. Estos pasos van acompañados por imágenes. Teniendo en cuenta los lenguajes del Wiki y la estructura, la persona que está realizando la documentación debe hacer su mejor esfuerzo para que las imágenes sean lo más adecuadas posibles.

• 3.2. Aplicación Web. Contiene los pasos que se deben llevar a cabo para ejecutar la funcionalidad en la aplicación web. Estos pasos van acompañados por imágenes. Teniendo en cuenta los lenguajes del Wiki y la estructura, la persona que está realizando la documentación debe hacer su mejor esfuerzo para que las imágenes sean lo más adecuadas posibles.

Contiene links con su respectiva descripción sobre información de la configuración externa a la funcionalidad. Por ejemplo, si se está documentando el envió de correos, podría tener información de cómo se configura el servidor SMTP.

Contiene información de configuraciones especiales en las cuales se espera un comportamientos diferente al normal. Por ejemplo, que una funcionalidad no se deba utilizar dentro de grillas.

Contiene las referencias (links) de otras funcionalidades de Bizagi que pueden ser de interés para el usuario que está leyendo el artículo.

http://wiki.bizagi.com/es/index.php?title=Plantilla_Funcional

[ocultar]

• 1 Mejores Prácticas de Documentación

o 1.1 Tips Prácticos

Construya sobre lo construido. Si no es una funcionalidad

...