.png)
El proyecto de documentación de Trust se centra en redactar el contenido de 17 APIs con un total de 80 endpoints, junto con la incorporación de 7 SDK que contienen su implementación y métodos en Android y iOS. Este proyecto tuvo su inicio después de que el equipo de desarrollo de Dolaresya! se enfrentara a la implementación de una API de reconocimiento de cédula de identidad.
Durante este proceso, el equipo de desarrollo compartió conmigo sus dificultades al encontrarse con documentación poco clara o incompleta, lo que dificultaba la implementación. Tras comunicarme con el equipo de Trust y revisar la documentación existente, pude comprobar que, si bien estaba completa, resultaba poco accesible para ciertos usuarios clave.
Motivado por esta situación, propuse mejorar la documentación para abordar dos objetivos fundamentales. En primer lugar, buscaba permitir que los desarrolladores que tuvieran que implementar los servicios de Trust lo hicieran de manera más eficiente y rápida, evitando así interrupciones en el equipo de desarrollo de Trust y ahorrando tiempo de trabajo.
En segundo lugar, tenía el propósito de disponer de una documentación clara y concisa que fuera fácilmente comprensible para equipos externos y posibles clientes. Esto permitiría que pudieran obtener rápidamente una visión general del servicio sin necesidad de acceder a detalles técnicos complejos.
En resumen, este proyecto surgió como una respuesta a las dificultades encontradas en el desarrollo de Dolaresya!, y busca mejorar la documentación de Trust para ofrecer una guía completa y accesible a los desarrolladores, así como a posibles clientes interesados en utilizar los servicios de Trust.
.png)
Para realizar este trabajo, fue fundamental leer detenidamente cada párrafo de la documentación y llevar a cabo revisiones periódicas con el líder de desarrollo de las APIs para asegurarme de que mi comprensión y redacción de los endpoints fueran precisas. Los principios que guiaron mi redacción fueron la claridad y la accesibilidad: mi objetivo era que cualquier persona pudiera leer la documentación y al menos comprender generalmente qué hacía cada API con su endpoint específico. Para lograrlo, realicé pruebas con usuarios que no tenían conocimientos previos sobre Trust y, en el extremo, con aquellos que desconocían qué era una API y el lenguaje que utilizaban los desarrolladores.
Los textos que me entregaron estaban en una documentación pública en el antiguo sitio de Trust y presentaban varias jergas y términos propios de los programadores y del equipo de Trust. Para mejorar la redacción, me enfoqué en minimizar el uso de lenguaje técnico innecesario y explicar los conceptos de manera más sencilla y comprensible para un público más amplio. El objetivo era que cualquier persona, incluso sin experiencia técnica, pudiera obtener una idea clara de las funcionalidades de las APIs y cómo utilizarlas en sus proyectos.
.png)
Durante el proceso de redacción, también me encargué de desarrollar un sistema y esquemas para que en el futuro esta documentación fuera integrada en Docusaurus, un framework especializado en este tipo de documentación, a través de un frontend que entendiera la plataforma. Esta medida se tomó para agilizar el proceso, ya que el contenido era bastante extenso.
La estructura de la documentación sigue un orden basado en la complejidad, de arriba hacia abajo, y se organiza de tal manera que los lectores puedan acceder a la información necesaria antes de abordar tareas posteriores. Por ejemplo, si en un endpoint se menciona una API que aún no ha sido presentada en el espectro, esta API se ubicará más arriba en la jerarquía para facilitar la comprensión.
Este enfoque se puede observar claramente en la reorganización de los endpoints denominados anteriormente como "Atenea" y "Chronos", los cuales ahora han sido renombrados como "Acceso de los servicios de Trust" y "Almacenamiento de archivos y creación de links temporales", respectivamente. Estas APIs son fundamentales para el uso de muchas otras, ya que proporcionan los accesos y el almacenamiento temporal de archivos y usuarios.
Aplicando esta lógica de organización internamente en cada endpoint, se logra que sean visualizados de forma coherente, lo que evita que el usuario se enfrente a lagunas de información al momento de su implementación. El objetivo principal es asegurar que los desarrolladores puedan navegar la documentación sin problemas, acceder a los datos pertinentes y comprender claramente cómo utilizar los servicios de Trust en sus proyectos.
