# (Plan de) Documentación

## Estructura Organizacional

### Sitio Documentación & Tutoriales

* Organización
* Software-Operations
* Ejecución
* Escritor Técnico
* Diseñador Gráfico
* Ingeniero Software
* Ingeniero Proyectos
* Product Owner
* Usuarios
* Administradores
* Implementadores
* Metas
* Administrador pueda encontrar como usar las herramientas
* Tutoriales simples para tareas comunes.
* Tutoriales para entender como unir las herramientas.
* Disminuir lo más posible la necesidad de HHs para responder preguntas

### Discussions

* Organización
* Software-operations
* Ejecución:
* Ingeniero Software
* Ingeniero Proyectos
* Usuarios
* Administradoes
* Implementadores
* Metas
* Abrir abiertamente las preguntas de la comunidad
* Atrapar temas que no están cubiertos en la documentación

### What's New & Publicaciones

* Organización
* Doc-Marketing
* Ejecución:
* Escritor Técnico
* Coordinador Marketing
* Diseñador Gráfico
* Ingeniero Software
* Product Owner
* Usuarios
* Equipo Interno
* Clientes
* Partners
* Administradores
* Implementadores
* Metas
* Dar a conocer nuevas funcionalidades
* Generar continuamente publicaciones de alta calidad

### Sitio Certificación

* Organización
* Doc-Marketing
* Ejecución
* Coach & Profesor
* Coordinador Marketing
* Escritor Técnico
* Diseñador Gráfico
* Usuarios
* Partners
* Metas
* Generar lazos profundos con partners

## Plan
- [x] Reunión periódica de planificación y determinar frecuencia necesaria
- [ ] Unificar inputs de communicación e.g, formulario contacto / landing / discussions / etc
- [x] Generar plan para avanzar en estos cuatro frentes
- [x] Documentación: Separar Modelos de API
- [x] Documentación: Soporte Ingeniería para API
- [x] Documentación: Incluir Swagger de core
- [ ] Documentación: Incluir Ejemplos reales en SQL
- [ ] Enviar ejemplo real de SQL
- [x] Ocultar certificacion
- [ ] Crear seccion de ejemplos
- [ ] Mover ejemplos a nueva seccion
- [ ] Presets ¿Cómo abordar esto?
- [ ] ¿Cúando traducir al español?
- [x] Crear issues o discussions
- [x] Re-estructurar Documentación: API y Models con secciones apartes, unir Getting Started con Cotalker App, Admin sección aparte

## Reunión 22/07/2021

### Discusión
- [x] Operaciones comenta que tuvo problemas con usar la documentación de workflows dado que no están actualizados los contextos.
- [X] Con el feedback de la semana pasada, se re-ordenó la documentación.
- [x] Operaciones conversó mucho sobre el concepto de "propiedades", el cuál es confuso. Ver como mejorar la explicación de como funcionan los "elements" en Cotalker.
- [x] La creación de una máquina de estado también representa problemas de intuitividad (states, stages, collections, assets, etc, que deberíamos poder buscar una forma de mejorar a través de la interfaz y de mejor documentación).
- [x] Deberíamos priorizar la documentación funcional (admin y ejemplos) por sobre la documentación técnica (API / SQL).
- [x] Crear un tutorial de cargas masivas (ej: properties, users) con postman usando la API.
- [x] Partners tendrán capacitacion de admin funcional, técnico e integraciones.
- [ ] Cómo podríamos mejorar la documentación del COT Lang? (principalmente el uso de los contextos).
- [ ] Cómo documentaremos el uso del FaaS?
- [ ] Cómo abordar la documentación de los presets? Podrían ser parte de la sección de tutoriales, explicando como se puede implementar una solución desde cero y dar ejemplos de como extender los presets standard. Pero debería tener menor prioridad que los puntos anteriores.

### Feedback Operaciones
- Nombre del estado no se entiende que es un nombre en la documentación
- Facilitar el cambio de estados condicionado por una respuesta del forulario
- Hacer la distinción entre los cambios de estado por interfaz o trigger
- Sólo usar una palabra survey o form
- Crear survey triggers es muy complicado de encontrar en la documentación. Sol: Sección routine builder debería estar más visible o haber más links a ella. Actualmente está en Configure workflows -> edit routine (link muy pequeño)
- El creador de rutinas no especifica dónde está el error, sólo queda en gris. Solución: al presionar guardar, que te envíe hacia el lugar del error
- Sección Routine builder: Se confunde dibujo de rutina con el de estados (palabras muy parecidas state - stage)
- Sección Create survey that starts a workflow - Steps - Create the survey form debería estar explicado con imágenes
- Bot that starts workflow está desactualizado - Dejar esto claro en la parte superior de la página con un link a la feature que se debería hacer
- Indicar cómo pensar el nombre de la tarea: En base a los campos del formulario, que sea lago no tan largo