Project Ensembl
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Halaman ini berisi detail project penulisan teknis yang diterima untuk
Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Ensembl
- Penulis teknis:
- laurelm
- Nama project:
- Dokumentasi REST API
- Durasi project:
- Durasi standar (3 bulan)
Project description
Meningkatkan panduan pengguna developer untuk menggunakan Ensembl REST API
Fokus utama -- Berikan bagian pengantar/mulai yang lebih mudah digunakan.
Implementasi yang diusulkan didasarkan pada halaman-halaman dokumen ini:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Halaman utama:
Mencakup bagian berikut (tampilan tingkat tinggi):
Ringkasan tentang apa yang disediakan API ini dalam istilah praktis
Pengantar singkat REST
Contoh singkat
Info autentikasi
Pengantar tentang cara URL disusun menggunakan berbagai metode HTTP
Info tentang parameter wajib dan opsional serta tempatnya ditemukan dalam dokumentasi endpoint yang dibuat secara otomatis.
Link ke halaman pelatihan berikut:
https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Info tentang helper_functions yang digunakan dalam kursus pelatihan
Halaman berikutnya
Bergantung pada kompleksitas topik yang tercantum di halaman utama, beberapa topik mungkin perlu ditautkan ke halaman detail berikutnya.
Kecuali disebutkan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-11-08 UTC.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2024-11-08 UTC."],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]
