Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- OpenMRS.org
- Technical Writer:
- Ayeshmantha
- Nome del progetto:
- Sviluppo di una documentazione di GitHub user-friendly per l'API REST
- Durata del progetto:
- Durata standard (3 mesi)
Project description
L'obiettivo principale del progetto è sviluppare una documentazione interattiva in cui gli utenti finali possano interagire con le API con opzioni di prova e, nel frattempo, avere una descrizione più descrittiva e autoesplicativa che spieghi alle persone tecniche e non tecniche in quali situazioni utilizzare l'endpoint.
L'attuale ambiente Swagger è fantastico, ma per chi non è esperto di tecnologia e per gli esperti è ancora più difficile farsi un'idea direttamente senza la documentazione adeguata. L'idea principale è riunire questo ambiente e la documentazione di Swagger in un unico posto con una bella rappresentazione. Con l'aiuto di JS, HTML e CSS.