OpenMRS.org 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：

OpenMRS.org

技術撰稿人：

Ayeshmantha

專案名稱：

開發適合 REST API 的 GithHub 說明文件

專案長度：

標準長度 (3 個月)

Project description

這項專案的主要目標是開發互動式說明文件，讓使用者與 API 的試用選項互動，同時提供描述性和自我說明的說明，向技術與非技術人員說明應使用端點的情況。

目前的 Swagger 環境非常棒，但對於非技術人員和技術人員來說，如果沒有適當的文件，要直接瞭解這個概念仍有難度。主要概念是將交換環境和說明文件集中在一處，並呈現良好的形象。藉助 JS、HTML 和 CSS。