このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- OpenMRS
- テクニカル ライター:
- 虹
- プロジェクト名:
- 新規デベロッパー向けの OpenMRS 技術ドキュメントの改善
- プロジェクトの期間:
- 標準の長さ（3 か月）
プロジェクトの説明
根拠
世界が COVID-19（新型コロナウイルス感染症）のパンデミックの影響に直面している今、OpenMRS のようなオープンソースの医療記録システムがこの種の危機に対するソリューションの一部となり得ることは、さらに明白です。新しいデベロッパーが OpenMRS エコシステムをナビゲートし、オンボーディング プロセスを短縮し、より多くの新規参入企業が OpenMRS の開発に迅速に貢献できるようにするには、簡潔で明確な最新のドキュメントを用意する必要があります。新しいデベロッパー向けの既存のドキュメントが 2 つあります。 • デベロッパー向けスタートガイド • デベロッパー マニュアル ただし、コンテンツの一部が古く、形式を改善する必要があります。このプロジェクトの目標は、コンテンツを更新し、これら 2 つのドキュメントの形式を改善して、よりユーザー フレンドリーにすることです。
範囲
- これら 2 つのドキュメントの内容を整理し、再フォーマットします。デベロッパー向けスタートガイド: a. 手順内の 17 のステップをセクションに分割し、各セクションのステップ数を減らすことで、ユーザーが簡単に進められるようにします。 b. 手順の順序を並べ替えてください。複数の手順を組み合わせることもできます。 c. 手順がより簡潔で読みやすいように、他の Wiki ページへのリンクを表にまとめてください。
デベロッパー マニュアルについて: a. 最初の数章の OpenMRS の背景情報は短くしてかまいません。ユーザーには OpenMRS.org のページで詳細を確認してもらうこともできます。 b. セットアップの章から開発プロセスの章に移る。
内容を更新します。 デベロッパー向けスタートガイド: a. Linux と Windows の環境設定を更新する（Docker を導入する） b. IntelliJ と Eclipse の IDE 構成の更新 c. デベロッパー マニュアルまたはデベロッパー ガイドへのリンク（該当する場合）。 d.リンク先のコンテンツがすべて最新であることを確認します。
デベロッパー マニュアルについて: a. 開発ワークフローを紹介します。 b.開発チームの編成方法、チームメンバーの共同作業方法を紹介します。チーム ミーティングやチーム ディスカッションへのリンクを追加し、新しいデベロッパーが参加したいチームを見つけられるようにします。 c.システム設定の章に Docker を追加。 d.さまざまな種類のモジュール（リファレンス アプリ モジュール、OWA モジュール、プラットフォーム モジュール）と、それらの連携に関する詳細を追加します。 e.さまざまな種類のモジュールがどのようにビルドされデプロイされるかを示す簡単なサンプルコードを追加します。 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 への貢献を検討している、中レベルの開発者や上級開発者です。このような経験豊富なデベロッパーには、2 つのドキュメントで OpenMRS の概要を説明し、デベロッパー ガイドやその他のリソースにあるテクノロジーの詳細を紹介するためのガイドとして利用できます。 経験豊富なデベロッパーの主な目標は次のとおりです。 1. OpenMRS のデータモデルとアーキテクチャを理解する 2. OpenMRS コミュニティに参加して、コミュニケーション ツールについて学びましょう。 3. OpenMRS コード リポジトリへのリンクをご確認ください。4. 詳細なリソースをご覧ください。
プロジェクトの計画
計画フェーズ: • [範囲] セクションで設定した目標を修正する • 古いコンテンツを特定する • 2 つのドキュメントの概要を作成する • 概要をメンターと対象分野のエキスパート（SME）に提示する • プロジェクト計画を更新する
コンテンツ開発フェーズ • Docker について学び、すべてのインストール手順を行い、簡単なサンプルコードやテストコードを作成する • SME に聞き取り調査を行う • 2 つのドキュメントの最初の下書きを作成する
コンテンツのレビューと公開 • コンテンツを自分で編集する • 完成したドラフトを審査担当者（メンターと SME）とエンドユーザーに送信してフィードバックを求める • ドラフトを改訂する • OpenMRS Wiki ページで 2 つのドキュメントを公開します。 • プロジェクト レポートを作成する
予備作業
Linux システムでの開発環境のセットアップと OpenMRS SDK のセットアップを行いました。IDE を設定している最中です。引き続き、シンプルなモジュールの構築とテストコードの記述を続けていきます。
リファレンスとディスカッション
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502