Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- OpenMRS.org
- Penulis teknis:
- batbrain7
- Nama proyek:
- Dokumentasi OpenMRS REST API
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Saya akan membagi proposal saya menjadi beberapa bagian dan akan mengikuti alurnya seperti dokumentasi Google Maps API dan dokumentasi API GitHub.
Selain itu, saya juga ingin mengusulkan struktur readme untuk dokumentasi API yang dilakukan oleh realworld.io: https://github.com/gothinkster/realworld/tree/master/api
Secara pribadi, saya merasa dokumentasi ini sangat mudah untuk dipahami dan digunakan.
Proposal saya sebagian besar akan terdiri dari 3 bagian :
Bagian yang memberikan pengantar singkat tentang API, tentang OpenMRS, dan tentang cara API digunakan, serta semua hal berikutnya setelahnya.
Cara mendapatkan kunci API dan autentikasi yang diperlukan secara umum untuk membuat permintaan API. Ini akan terdiri dari contoh contoh jenis autentikasi yang ada pada API serta kunci dan nilai yang harus ada untuknya, serta jenis nilai yang diterima sesuai dengan kunci di bagian tersebut. Contoh kode dalam bahasa apa pun akan membantu dan memperjelas cara menulis header dan format respons serta parameter kueri lainnya di API.
Jenis respons yang diambil oleh API, jenis JSON atau jenis hasil lain yang ditampilkan oleh API akan disebutkan.
Rute API yang berbeda dan semua parameter yang perlu dikirim bersama dengan rute tersebut, header, dan lainnya. Setiap API akan dibantu oleh contoh kode dalam beberapa bahasa yang menjelaskan bagaimana permintaan dibuat saat menulis kode untuk itu, selain dari kode error umum yang dapat ditemukan dengan setiap API juga harus disebutkan.
Ini adalah gambaran umum tentang bagaimana dokumentasi akan didefinisikan untuk REST API.
Jadwal untuk proyek tersebut adalah sebagai berikut :
1 Agustus - 1 September
Berkenalan dengan mentor saya dan membahas secara lebih mendalam tingkat dokumentasi yang diperlukan di berbagai bagian codebase dan juga membahas seberapa mendalam penggunaan dokumentasi tingkat rendah vs tingkat tinggi. Saya juga akan menghabiskan waktu ini untuk memahami codebase dan mempelajari konsepnya sehingga saya dapat mendokumentasikannya dengan lebih baik.
Minggu ke-1 & 2
Saya akan memperbarui dan memperluas panduan kontributor. Saya akan memperbaiki dokumentasi tentang cara membangun kode sumber. Saya juga akan menambahkan bagian pendokumentasi tentang bagaimana kontributor baru dapat membantu dalam dokumentasi. Saya akan mempelajari dokumentasi API yang berbeda dan mulai dengan pengenalan dan menambahkan autentikasi untuk API.
Minggu ke-3 - 8
Saya akan menambahkan rute dan respons API beserta beberapa contoh kode untuk setiap jenis API (mungkin ada jenis API yang serupa).
Minggu ke-9 & ke-10
Menambahkan penataan dokumentasi API menggunakan link, yaitu indeks tertaut untuk dokumentasi API yang panjang dan membaginya lebih lanjut dalam berbagai dasar seperti bagian kode, ringkasan, parameter, endpoint root.
Minggu Terakhir
Saya akan menggunakan minggu terakhir untuk mempersiapkan laporan akhir dari pekerjaan yang telah saya lakukan selama periode dokumentasi 12 minggu. Saya juga akan meluangkan waktu ini untuk meninjau dan menyelesaikan dokumentasi.