OpenMRS プロジェクト

このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。

プロジェクトの概要

オープンソースの組織:
OpenMRS
テクニカル ライター:
虹
プロジェクト名:
新規デベロッパー向けの OpenMRS 技術ドキュメントの改善
プロジェクトの期間:
標準の期間（3 か月）

プロジェクトの説明

背景

COVID-19（新型コロナウイルス感染症）のパンデミックの影響が世界に及ぶ中、OpenMRS のようなオープンソースの医療記録システムがこの種の危機のソリューションの一部となりうることは、さらに明白です。新しい開発者が OpenMRS エコシステムをナビゲートし、オンボーディング プロセスを短縮し、より多くの新規参入企業が OpenMRS の開発に迅速に貢献できるようにするには、簡潔で明確な最新のドキュメントを用意する必要があります。新規デベロッパー向けに既存のドキュメントが 2 つあります。 • デベロッパー向けスタートガイド • デベロッパー マニュアル ただし、内容の一部は古く、形式を改善する必要があります。このプロジェクトの目標は、内容を更新し、これら 2 つのドキュメントの形式を改善して、さらにユーザー フレンドリーにすることです。

範囲

  1. これら 2 つのドキュメントの内容を整理して再フォーマットします。デベロッパー向けドキュメント: 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 モジュール、プラットフォーム モジュール）とそれらの連携についての詳細を追加します。 各種のモジュールがどのようにビルドされデプロイされるかを示す簡単なサンプルコードを追加します。 f.モジュールの種類ごとに簡単なテスト例を追加します。

オーディエンス分析

デベロッパー向けスタートガイドとデベロッパー マニュアルは、OpenMRS の知識がほとんどまたはまったくないデベロッパーを対象としています。 開発者は 2 種類あります 1 つ目はソフトウェア開発経験がほとんどないかまったくないベテラン開発者ですたとえば、オープンソース ソフトウェア開発について学ぶために現実世界のプロジェクトを探している GSoC の学生などがこれに該当します。そのようなデベロッパーにとっては、知識のギャップを埋め、比較的短期間で OpenMRS プロジェクトに貢献できるように、2 つのドキュメントで十分な詳細とリファレンスを提示する必要があります。 経験の浅いデベロッパーの主な目標は次のとおりです。 1. OpenMRS（MySQL、Java Spring. React.js、Git など）に移動し、これらのスキルを習得するためのリソースをご覧ください。 2. OpenMRS コミュニティに参加して、コミュニケーション ツールについて学びましょう。 3. 環境と IDE を設定します。 4. OpenMRS SDK をインストールします。 5. 開発ワークフローを理解します。6. 新しいモジュールを作成するためのシンプルなコードを作成します。 7. 新しく作成したモジュールをデプロイします。8. モジュールのテスト 9. Git を使用して pull リクエストを行います。2 つ目のユーザー層は、組織のニーズに合わせた OpenMRS のカスタマイズや、OpenMRS への貢献を検討している、ミドルレベルのデベロッパーやシニア デベロッパーです。このような経験豊富なデベロッパーには、OpenMRS の概要を説明する 2 つのドキュメントが用意されており、デベロッパー ガイドやその他のリソースにあるテクノロジーの詳細情報を紹介するためのガイドとして役立ちます。 経験豊富なデベロッパーの主な目標は次のとおりです。 1. OpenMRS のデータモデルとアーキテクチャを理解する 2. OpenMRS コミュニティに参加して、コミュニケーション ツールについて学びましょう。 3. OpenMRS コード リポジトリへのリンクを見つけます。4. その他のリソースをご確認ください。

プロジェクトの計画

  1. 計画フェーズ: • [範囲] セクションで設定した目標を改善する • 古いコンテンツを特定する • 2 つのドキュメントの概要を作成する • メンターと対象分野のエキスパート（SME）に概要を提示します • プロジェクト計画を更新します

  2. コンテンツ開発フェーズ • Docker について学び、すべてのインストール手順を行って、簡単なサンプルコード/テストコードを作成する • SME に質問する • 2 つのドキュメントの最初のドラフトを作成する

  3. コンテンツのレビューと公開 • コンテンツを自身で編集します • 完成した下書きをレビュー担当者（メンターと SME）とエンドユーザーに送信してフィードバックを求める • 下書きを修正します • OpenMRS Wiki ページで 2 つのドキュメントを公開します。 • プロジェクト レポートを作成する

予備作業

Linux システムでの開発環境のセットアップと OpenMRS SDK のセットアップの作業を行いました。IDE を設定しています。今後も、シンプルなモジュールの構築とテストコードの記述に取り組んでいきます。

参考資料とディスカッション

https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502