OpenMRS 项目

本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。

项目摘要

开源组织：
OpenMRS
技术文档工程师：
彩虹
项目名称：
为新开发者改进 OpenMRS 技术文档
项目时长：
标准时长（3 个月）

Project description

理由

随着全球新冠肺炎 (COVID-19) 疫情带来的后果，更加明显的是，OpenMRS 等开源医疗记录系统可以成为解决此类危机的一部分。 为了帮助新开发者熟悉 OpenMRS 生态系统、缩短他们的新手入门流程，并让更多新开发者能够快速为 OpenMRS 的开发做出贡献，您需要提供简洁、清晰且最新的文档。目前已有以下两个文档供新开发者使用： • 开发者入门 • 开发者手册 但是，部分内容已过时，格式需要改进。本项目的目标是更新上述两个文档的内容并改进其格式，使之更加人性化。

范围

  1. 重新整理这两个文档的内容，并重新设置其格式。 对于开发者入门文档： a. 将说明中的 17 个步骤分成若干部分，每个部分包含的步骤较少，以便于用户执行。 b. 重新排列各个步骤的顺序；某些步骤可以组合起来。 c. 以表格形式列出指向其他 Wiki 页面的链接，以使说明更加简洁易读。

对于开发者手册： a. 前几章中的 OpenMRS 背景信息可以缩短，用户可以转到 OpenMRS.org 页面查找更多详细信息。 b. “设置”章节应移至“开发流程”章节之前

  1. 更新内容。 对于开发者入门文档： a. 更新为 Linux 和 Windows 设置的环境（引入 Docker） b. 更新 IntelliJ 和 Eclipse 的 IDE 配置 c. 提供指向开发者指南或开发者指南的链接（如果适用）。 d.确保所有指向内容的链接都是最新的。

    对于开发者手册： a. 介绍开发工作流。 b.介绍开发团队的组建方式以及团队成员的协作方式；添加团队会议和团队讨论的链接；帮助新开发者找到可能想要加入的团队。 c.在系统设置章节中添加 Docker。 d.添加有关不同类型模块（参考应用模块、OWA 模块和平台模块）以及它们如何协同工作的更多详细信息。 e.添加简单的示例代码，展示如何构建和部署每种模块。 f.为每种模块添加简单的测试示例。

受众群体分析

《开发者入门》和《开发者手册》的目标受众是对 OpenMRS 知之甚少或一无所知的开发者。 开发者可能分为两类：第一类受众群体是没有软件开发经验很少或根本没有软件开发经验的初级开发者。例如，正在寻找真实项目来学习开源软件开发的 GSoC 学生。对于这些开发者，这两个文档应该提供足够的详细信息和参考，以便他们能够开始填补知识缺口，并在相对较短的时间内为 OpenMRS 项目做出贡献。 初级开发者的主要目标包括： 1. 了解参与 OpenMRS（MySQL、Java SpringReact.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. 查找更深入的资源。

项目计划

  1. 规划阶段： • 优化“范围”部分设定的目标 • 找出过时的内容 • 为两个文档拟定大纲 • 向导师和领域专家 (SME) 展示大纲 • 更新项目计划

  2. 内容开发阶段 • 了解 Docker，完成所有安装步骤，并生成简单的示例代码/测试代码 • 采访 SME 以提问 • 编写两个文档的初始草稿

  3. 内容审核和发布 • 自行修改内容 • 将完成的草稿发送给审核者（导师和 SME）和最终用户以获得反馈 • 修改草稿 • 在 OpenMRS Wiki 页面中发布这两个文档。 • 编写项目报告

前期工作

我对在 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 https://talk.openmrs.org/news-analytics-9/2/2/2/2/12 上