Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- OpenMRS.org
- Rédacteur technique:
- Ayeshmantha
- Nom du projet:
- Développer une documentation GithHub conviviale pour l'API REST
- Durée du projet:
- Durée standard (3 mois)
Project description
L'objectif principal du projet est de développer une documentation interactive permettant aux utilisateurs finaux d'interagir avec les API à l'aide d'options d'essai et, entre-temps, d'avoir une description plus descriptive et auto-explicative qui explique aux techniciens et aux non-techniques dans quelle situation ils doivent utiliser le point de terminaison.
L'environnement fanfaron actuel est idéal, mais pour les non-techniciens et les technophiles, il est toujours plus difficile d'obtenir une idée directement sans documentation appropriée. L'idée principale serait de rassembler cet environnement fantaisiste et cette documentation en un seul endroit avec une belle représentation. Avec l'aide de JavaScript, HTML et CSS.