Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- OpenMRS.org
- Penulis teknis:
- Ayeshmantha
- Nama proyek:
- Mengembangkan Dokumentasi GithHub yang Mudah Digunakan untuk REST API
- Durasi project:
- Durasi standar (3 bulan)
Project description
Tujuan utama project ini adalah mengembangkan dokumentasi interaktif tempat pengguna akhir dapat berinteraksi dengan API dengan opsi coba dan pada saat yang sama memiliki deskripsi yang lebih deskriptif dan dapat dijelaskan sendiri yang menjelaskan kepada orang-orang teknis dan non-teknis tentang situasi yang harus digunakan endpoint.
Lingkungan swagger saat ini sangat bagus, tetapi bagi mereka yang bukan ahli teknologi dan ahli teknologi, akan lebih sulit untuk mendapatkan ide secara langsung tanpa dokumentasi yang tepat. Ide utamanya adalah mendapatkan lingkungan dan dokumentasi swagger ini di satu tempat dengan representasi yang bagus. Dengan bantuan JS, HTML, dan CSS.