Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- OpenMRS.org
- Technischer Redakteur:
- Ayeshmantha
- Projektname:
- Nutzerfreundliche GithHub-Dokumentation für die REST API entwickeln
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Das Hauptziel des Projekts ist es, eine interaktive Dokumentation zu entwickeln, in der Endnutzer mit APIs interagieren können, um Optionen auszuprobieren. In der Zwischenzeit haben sie eine aussagekräftigere und selbsterklärendere Beschreibung, in der technisch und technisch nicht versierten Personen erklärt wird, in welcher Situation der Endpunkt verwendet werden sollte.
Die aktuelle Situation ist großartig, aber für Nicht-Techniker und Technikfreaks ist es immer noch schwieriger, ohne ordnungsgemäße Dokumentation eine Idee direkt zu bekommen. Die Grundidee ist es, diese coole Umgebung und Dokumentation an einem zentralen Ort mit ansprechenden Darstellungen zu präsentieren. Mit JS, HTML und CSS.