Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- OpenMRS.org
- Technical writer:
- Ayeshmantha
- Nome progetto:
- Sviluppo di una documentazione di GithHub facile da usare 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 mediante le opzioni di prova e, nel frattempo, avere una descrizione più descrittiva e autoesplicante che spieghi alle persone tecniche e non tecniche la situazione in cui si dovrebbe usare l'endpoint.
L'attuale ambiente spavaldo è ottimo, ma per gli amanti della tecnologia e degli amanti della tecnologia è ancora più difficile farsi un'idea direttamente senza la documentazione adeguata. L'idea principale è raccogliere questo ambiente spavaldo e la documentazione in un unico posto con una bella rappresentazione. Con l'aiuto di JS, HTML e CSS.