本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- OpenMRS
- 技術文件撰寫者：
- 彩虹
- 專案名稱：
- 為新開發人員改善 OpenMRS 技術說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
原因
隨著全世界受到 COVID-19 疫情的影響，我們更明顯看出 OpenMRS 等開放原始碼醫療記錄系統有助於解決這類危機。 為了協助新開發人員熟悉 OpenMRS 生態系統、縮短新手上路流程，並讓更多新手能夠迅速參與 OpenMRS 的開發工作，有必要提供簡單明瞭且符合現況的文件。我們推出了兩份現有文件，供新開發人員參考： • 以開發人員身分踏出第一步 • 開發人員手冊 不過有些內容已過時，格式需要改善。這項專案的目標是更新內容並改善這兩份文件的格式，讓使用者更容易理解。
範圍
- 重新整理這兩份文件的內容並重新設定格式。 對於「開始使用」開發人員文件： a. 將操作說明中的 17 個步驟劃分成幾個部分，每個部分包含的步驟較少，方便使用者操作。 b. 重新排列步驟的順序；某些步驟可以合併使用。c. 在表格內列出其他維基網頁的連結，讓操作說明更簡潔易讀。
針對開發人員手冊： a. 前幾個章節中的 OpenMRS 背景資訊可以縮短，引導使用者前往 OpenMRS.org 頁面獲取更多詳細資訊。 b. 「設定」章節必須在「開發程序」章節之前先移動
更新內容。 關於「開始使用」開發人員文件： a. 更新針對 Linux 和 Windows 設定的環境 (引入 Docker) b. 更新 IntelliJ 和 Eclipse 的 IDE 設定。連結至開發人員指南 (如適用)。 確定所有連結內容都是最新版本。
針對開發人員手冊： a. 介紹開發工作流程。 b.介紹開發團隊的組織方式、團隊成員協作的方式；加入團隊會議和團隊討論的連結；協助新開發人員找到想要加入的團隊。 c.在系統設定章節中新增 Docker。新增更多不同類型模組 (參考應用程式模組、OWA 模組和平台模組) 如何搭配運作，例如：新增簡單的程式碼範例，示範如何建構及部署每種模組。 f.為每種模組新增簡單的測試範例。
目標對象分析
歡迎閱讀新手入門和開發人員手冊的適用對象，為對 OpenMRS 不太瞭解或完全沒有瞭解的開發人員。 開發人員分為兩種類型： 第一種目標對像是較小型開發人員，而且沒有具備軟體開發經驗或甚至沒有經驗的開發人員。例如，GSoC 學生需要透過實際專案瞭解開放原始碼軟體開發。這兩個文件應提供足夠的詳細資料和參考資料，以便他們開始填補知識缺口，並在極短的時間內開始對 OpenMRS 專案做出貢獻。 初級開發人員的主要目標如下： 1. 瞭解使用 OpenMRS (MySQL、Java Spring，React.js、Git 等)，並尋找學習這些技能的資源。2. 加入 OpenMRS 社群，瞭解通訊工具。3. 設定環境和 IDE。4. 安裝 OpenMRS SDK。5. 瞭解開發工作流程。6. 產生簡單的程式碼來建立新模組。7. 部署新建立的模組。8. 測試模組。9. 使用 Git 發出提取要求。第二類目標對像是中階開發人員或資深開發人員，希望根據自身機構的需求自訂 OpenMRS，或是為 OpenMRS 做出貢獻。對於經驗豐富的開發人員，這兩份文件應提供 OpenMRS 總覽，並引導他們參閱開發人員指南和其他資源中更深入的技術詳細資訊。 資深開發人員的主要目標如下： 1. 瞭解 OpenMRS 的資料模型和架構 2. 加入 OpenMRS 社群，瞭解通訊工具。3. 尋找 OpenMRS 程式碼存放區的連結。 4. 尋找更多深入資源。
專案計畫
規劃階段： • 修正「範圍」部分設定的目標 • 找出過時的內容 • 製作兩份文件的大綱 • 向導師和主題內容專家 (SME) 展示大綱 • 更新專案計畫
內容開發階段 • 瞭解 Docker、完成所有安裝步驟，並產生簡單的程式碼範例/測試程式碼 • 訪問主題專家並提問 • 製作兩份文件的第一份草稿
內容審查及發布 • 自行編輯內容 • 將完成的草稿傳送給審查人員 (指導者和主題專家) 和使用者提供意見 • 修改草稿 • 在 OpenMRS 維基頁面中發布這兩份文件。 • 編寫專案報告
初步工作
我已在 Linux 系統和 OpenMRS SDK 中設定開發環境，目前正在設定 IDE，我會繼續建構簡單的模組，並編寫測試程式碼。
參考資料與討論
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/14、