本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织：
- OpenMRS
- 技术文档工程师：
- 彩虹
- 项目名称：
- 为新开发者改进 OpenMRS 技术文档
- 项目时长：
- 标准时长（3 个月）
Project description
理由
随着世界各地深受新冠疫情的影响，我们更加清楚地认识到，OpenMRS 等开源医疗记录系统可以成为应对此类危机的解决方案之一。 为了帮助新开发者熟悉 OpenMRS 生态系统、缩短新手入门流程，并让更多新手能够快速为 OpenMRS 的开发做出贡献，我们必须提供简洁、清晰且最新的文档。目前有两份面向新开发者的文档： • 开发者入门 • 开发者手册 不过，其中一些内容已过时，格式也需要改进。此项目的目标是更新这两份文档的内容并改进其格式，使其更易于用户使用。
范围
- 重新整理并重新设置这两份文档的内容格式。 对于“开始成为开发者”文档： a. 将说明中的 17 个步骤分成若干部分，每个部分包含的步骤更少，以便用户更轻松地完成操作。 b. 重新排列步骤的顺序；有些步骤可以合并。 c. 在表格中列出指向其他维基页面的链接，以便说明更简洁、更易读。
对于开发者手册： a. 可以缩减前几章中的 OpenMRS 背景信息，并将用户定向至 OpenMRS.org 页面了解更多详情。 b. “设置”一章应移至“开发流程”一章之前
更新内容。 对于“开发者入门”文档： 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 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，完成所有安装步骤，并生成简单的示例代码/测试代码 • 采访 SME 提问 • 编写两份文档初稿
内容审核和发布 • 自行编辑内容 • 将完成的草稿发送给审核人员（导师和 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/t/looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https://talk.openmrs.org/t/a-possible-new-gsod-2020-project/28947