Documentación General de Tecnología
El propósito de esta documentación es poder encontrar en un solo lugar toda la información relacionada con el funcionamiento de los sistemas de Reservamos desde el nivel más alto para que cualquier persona lo pueda entender.
¿Para quién es la documentación?
Es para uso interno de Reservamos y útil para todas las áreas. Todos pueden contribuír dando retroalimentación para hacerla más completa y el equipo de Tecnología se encarga de mantenerla actualizada. Se puede consultar en https://docs.reservamos.mx con una cuenta de usuario y contraseña.
Problemas que soluciona la documentación
- Encontrar respuestas a preguntas relacionadas con los sitemas de Reservamos, por ejemplo:
- ¿Qué tipos de integraciones tenemos?
- ¿Cómo funcionan los viajes con conexión?
- ¿Qué dominios/subdominios tenemos activos?
- ¿Cuál es nuestro ambiente de pruebas?
- Entender procesos como compras manuales, antifraude, programas de lealtad, etc.
- Entender cómo están conectados los sistemas
- Glosarios de términos usados en Reservamos
- Facilitar el proceso de onboarding
Mantenimiento de la documentación
Se sigue la filosofía de docs-as-code donde se busca escribir la documentación con las mismas herramientas y principios que se usan para escribir código:
- Issue Trackers
- Version Control (Git)
- Plain Text Markup (Markdown, reStructuredText, Asciidoc)
- Code Reviews
- Continuous publication
En general tiene estos beneficios:
- Documentación escrita por el equipo de tecnología al mismo tiempo que el código
- Se puede revisar y corregir cualquier cambio que se haga en la documentación
- Ownership de la documentación por el equipo de tecnología
- Mejor entendimiento de los procesos internos de Reservamos entre todas las áreas
Más información en https://www.writethedocs.org/guide/docs-as-code
Retroalimentación
Pendiente definir un proceso para recibir feedback de todo el equipo. Lo ideal sería usando issues en el repo de Github, pero esto quiere decir que las personas que puedan dar feedback deben tener una cuenta de Github porque es un repo privado.