Progetto OpenMRS.org
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
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.
Salvo quanto diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2025-07-25 UTC."],[],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"]]
