本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- OpenMRS.org
- 技術撰稿人：
- Ayeshmantha
- 專案名稱：
- 為 REST API 開發使用者友善的 GithHub 說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
這項專案的主要目標，是開發互動式說明文件，讓使用者與 API 的試用選項互動，同時提供更詳細的說明和自我說明，協助技術人員與非技術人員瞭解哪些情況下應使用端點。
雖然目前的零工環境很不錯，但對於非技術人員與技術人員而言，仍會較難直接瞭解問題所在，卻沒有適當文件。主要概念是將雜亂的環境和說明文件集中在一處，以便呈現良好的形象。藉助 JS、HTML 和 CSS 的協助。