Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- OpenMRS.org
- Redactor técnico:
- Ayeshmantha
- Nombre del proyecto:
- Cómo desarrollar documentación de GithHub fácil de usar para la API de REST
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
El objetivo principal del proyecto es desarrollar una documentación interactiva en la que los usuarios finales puedan interactuar con las APIs a través de opciones de prueba y, mientras tanto, tener una descripción más descriptiva y autoexplicada que explique a las personas técnicas y no técnicas en qué situación se debería usar el endpoint.
El entorno actual de Swagger es excelente, pero para los no tecnólogos y los tecnólogos, es más difícil obtener una idea directamente sin la documentación adecuada. La idea principal sería obtener este entorno y documentación de swagger en un solo lugar con una buena representación. Con la ayuda de JS, HTML y CSS.