Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of Dokumen.
Ringkasan proyek
- Organisasi open source:
- OpenMRS.org
- Penulis teknis:
- Aisya
- Nama proyek:
- Mengembangkan Dokumentasi GithHub yang Mudah Digunakan untuk REST API
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Tujuan utama dari proyek ini adalah untuk mengembangkan dokumentasi interaktif di mana pengguna akhir dapat berinteraksi dengan API dengan opsi uji coba dan sementara itu memiliki deskripsi yang lebih deskriptif dan dijelaskan sendiri yang menjelaskan orang-orang teknis dan nonteknis tentang situasi apa yang harus menggunakan titik akhir.
Lingkungan yang modern saat ini sangat bagus, tetapi bagi non-teknisi dan teknisi tetap lebih sulit untuk mendapatkan ide secara langsung tanpa dokumentasi yang tepat. Ide utamanya adalah menempatkan lingkungan dan dokumentasi swagment ini di satu tempat dengan representasi yang bagus. Dengan bantuan JS, HTML, dan CSS.