Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- OpenMRS.org
- Technischer Redakteur:
- Ayeshmantha
- Projektname:
- Entwicklung einer nutzerfreundlichen GitHub-Dokumentation für die REST API
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Das primäre Ziel des Projekts besteht darin, eine interaktive Dokumentation zu entwickeln, in der Endnutzer mit APIs mit Testoptionen interagieren können. Gleichzeitig soll eine detailliertere und selbsterklärende Beschreibung vorhanden sein, die technischen und nicht technischen Personen erklärt, in welchen Situationen der Endpunkt verwendet werden sollte.
Die aktuelle, brillante Umgebung ist toll, aber für Technikfreaks und Technikfreaks ist es ohne eine entsprechende Dokumentation immer noch schwieriger, eine Idee direkt zu entwickeln. Die Hauptidee besteht darin, diese Swagger-Umgebung und -Dokumentation an einem Ort mit einer ansprechenden Darstellung zu präsentieren. Mithilfe von JS, HTML und CSS.