このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- OpenMRS
- テクニカル ライター:
- レインボー
- プロジェクト名:
- 新規デベロッパー向けの OpenMRS 技術ドキュメントの改善
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
根拠
世界が COVID-19 パンデミックの影響に苦しむ中、OpenMRS のようなオープンソースの医療記録システムが、このような危機に対する解決策の一部になり得ることがますます明らかになっています。新しいデベロッパーが OpenMRS エコシステムを操作し、オンボーディング プロセスを短縮し、より多くの新規参入者が OpenMRS の開発に迅速に貢献できるようにするには、簡潔で明確で最新のドキュメントが必要です。新規デベロッパー向けのドキュメントは、次の 2 つがあります。 • デベロッパーとしてのスタートアップ • デベロッパー マニュアル ただし、一部のコンテンツは古く、形式も改善が必要です。このプロジェクトの目的は、これらの 2 つのドキュメントのコンテンツを更新し、形式を改善して、より使いやすくすることです。
範囲
- これらの 2 つのドキュメントの内容を整理し、書式を変更します。Getting Started as a Developer ドキュメント: 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. 各種類のモジュールに簡単なテスト例を追加します。
オーディエンスの分析
Getting Started as a Developer とデベロッパー マニュアルは、OpenMRS の知識がほとんど、またはまったくないデベロッパーを対象としています。 デベロッパーには次の 2 つのタイプがあります。1 つ目のタイプは、ソフトウェア開発の経験がほとんどない、またはまったくないジュニア デベロッパーです。たとえば、オープンソース ソフトウェア開発について学ぶために実社会のプロジェクトを探している GSoC の学生などです。これらのデベロッパーは、これらの 2 つのドキュメントに記載されている十分な詳細と参照情報に基づいて、知識のギャップを埋め、比較的短い期間で OpenMRS プロジェクトに貢献できるようになります。ジュニア デベロッパーの主な目標は次のとおりです。 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 の概要を説明するとともに、デベロッパー ガイドやその他のリソースで技術の詳細を確認するためのガイドとして機能します。経験豊富なデベロッパーの主な目標は次のとおりです。OpenMRS のデータモデルとアーキテクチャを理解します。OpenMRS コミュニティに参加して、コミュニケーション ツールについて学びましょう。3. OpenMRS コード リポジトリへのリンクを確認します。4. 詳細なリソースを探す。
プロジェクト計画
計画フェーズ: • スコープ セクションで設定した目標を絞り込みます。 • 古いコンテンツを特定します。 • 2 つのドキュメントの概要を作成します。 • 概要をメンターと Subject Matter Experts（SME）に提示します。 • プロジェクト計画を更新します。
コンテンツ開発フェーズ • Docker について学び、すべてのインストール手順を実行し、簡単なサンプルコード/テストコードを作成する • SME にインタビューして質問する • 2 つのドキュメントの最初のドラフトを作成する
コンテンツの確認と公開 • コンテンツを自己編集します。 • 完成した下書きをレビュー担当者（メンターと SME）とエンドユーザーに送信してフィードバックを求めます。 • 下書きを修正します。 • 2 つのドキュメントを OpenMRS ウィキページに公開します。• プロジェクト レポートを作成する
準備作業
Linux システムでの開発環境の設定と OpenMRS SDK の設定について、いくつか作業を行いました。IDE の設定を進めています。引き続き、シンプルなモジュールの作成とテストコードの作成に取り組みます。
参照とディスカッション
https://talk.openmrs.org/t/breaking-downmrs.org/t/breaking-down-walls-