このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- INCF
- テクニカル ライター:
- hq
- プロジェクト名:
- オープン再現性のある神経科学のための LORIS トレーニング ドキュメント
- プロジェクトの期間:
- 長時間（5 か月）
プロジェクトの説明
I. 抽象化
Longitudinal Online Research and Imaging System（LORIS）は、ニューロイメージング研究のためのウェブ対応のプロジェクト管理プラットフォームで、複数のオープン サイエンス イニシアチブをサポートしています。LORIS ではドキュメントが重要な役割を果たします。具体的には、ドキュメントによって LORIS のユーザーと開発者がプラットフォームをより適切に使用したり、ソフトウェア開発に貢献したりできるように、ソフトウェアの詳細を理解できます。同時に、LORIS のドキュメントも更新する必要があります。このプロジェクトは、LORIS のドキュメントの改善を支援することを目的としています。
II. 現在のステータス
LORIS は現在、GitHub Wiki、Read the Docs、LORIS.ca ウェブサイトを使って、すべてのドキュメントをホストしています。特に、LORIS GitHub Wiki は大量の LORIS ドキュメントがホストされており、追加の LORIS チュートリアル、プレゼンテーション、ユーザーガイド、チュートリアルはさまざまなプラットフォームでホストされています。現在の LORIS ドキュメントは LORIS の開発者とユーザー向けのガイドになっていますが、特にドキュメントの更新や技術的な詳細の改善において、さらなる開発と整理がメリットとなる可能性があります。
III. コミュニティにとってのメリット
オープン再現性のある神経科学向けの LORIS トレーニング ドキュメントを改善することで、研究者とデベロッパーはよりユーザー フレンドリーなツールの恩恵を受け、研究におけるデータ収集を改善できます。具体的には、LORIS のインストールと設定に関するドキュメントや、新規ユーザーにトレーニングを提供するエンドユーザー資料が更新され、改善される可能性があります。さらに、LORIS GitHub Wiki のドキュメントの移行と更新を支援して、ドキュメントを読むこともできるようにすることを目的としています。また、データの関係性を伝え、アーキテクチャの可視化を改善するためのデータベース図を提供する場合もあります。最後に、このプロジェクトでは、LORIS とそのオープン サイエンスのコンテキスト、そのユースケースを紹介するコンテンツを更新し、改善します。
IV. プロジェクトにおける個人的な強み
この数年間、いくつかの技術プロジェクトに参加し、それらを通じてテクニカル ライティングの豊富な経験を積みました。具体的には、過去の複数のチーム プロジェクトでドキュメントの作成を担当していました。また、Read the Docs、Sphinx、Mkdocs、Markdown、LaTeX などのテクニカル ライティング ツールの使用については十分な経験があると考えています。一方、STEM コースで教えた経験により、テクニカル コミュニケーションのスキルも向上しました。INCF によるオープンな再現性のある神経科学プロジェクトのための LORIS トレーニング ドキュメントは、私のテクニカル ライティング技術を LORIS に応用する絶好の機会になるでしょう。さらに、ニューロイメージングの分野にも強い関心を持っており、自分の技術的知識をこの分野に応用する機会を探っています。INCF とともにオープンかつ再現可能な神経科学プロジェクトのための LORIS トレーニング ドキュメントは、私にとって貴重な経験になるでしょう。
V. 成果物
- 現在の LORIS ドキュメントの移行と更新
- LORIS のインストールや設定に関するドキュメントの見直し、更新、改善を行い、エンドユーザー向けの資料で不足している情報を補完して、新規ユーザーにトレーニングを提供する
- データの関係（被験者、研究訪問など）を伝え、アーキテクチャの可視化を改善するためのデータベース図の生成を支援
- LORIS API ドキュメントの更新と改善にご協力ください
- LORIS とそのオープン サイエンスのコンテキスト、そのユースケースを紹介するコンテンツの更新と改善にご協力ください（複数のメディア形式を含む）
VI. タイムライン
コミュニティの絆（8 月 17 日～ 9 月 13 日） a）LORIS ソフトウェアとチームのワークフローを完全に理解する。 b）LORIS のインストールと設定に関するドキュメントを確認、更新、改善する。
第 1 週（9 月 14 日～ 9 月 20 日） GitHub Wiki の LORIS ドキュメントを更新して「ドキュメントを読む」に移行します。
第 2 週（9 月 21 日～ 9 月 27 日） a）最新の LORIS エンドユーザー資料を確認します。b）現在のドキュメントに基づいて、新規ユーザーにトレーニングを提供する LORIS エンドユーザー資料の不足を補う。
第 3 週（9 月 28 日～ 10 月 4 日） LORIS エンドユーザー向け資料を完成させて、新規ユーザーにトレーニングを提供します。
第 4 週（10 月 5 日～ 10 月 11 日） a）現在の LORIS データベース アーキテクチャを理解する。 b）LORIS プラットフォームのデータベース図の実装を開始する。
第 5 週（10 月 12 日～ 10 月 18 日） a）LORIS データベース図の生成タスクを完了する。 b）現在の LORIS API を確認し、API ドキュメントの改善に取り組みます。
第 6 週（10 月 19 日～ 10 月 25 日） 引き続き LORIS API ドキュメントの改善に取り組みます。
第 7 週（10 月 26 日～ 11 月 1 日） LORIS API ドキュメントの改善を完了します。
第 8 週（11 月 2 日～ 11 月 8 日） LORIS を紹介する現在のコンテンツを確認し、オープンな科学のコンテキストの更新や改善に着手します。
第 9 週（11 月 9 日～ 11 月 15 日） LORIS を紹介するコンテンツで、オープン サイエンスのコンテキストに関する最新情報と改善を完了します。
第 10 週（11 月 16 日～ 11 月 22 日） LORIS を紹介するコンテンツ内のユースケースの一部の更新と改善にご協力ください。
第 11 週（11 月 23 日～ 11 月 29 日） LORIS を紹介するコンテンツ内のすべてのユースケースの更新と改善を完了します。
プロジェクトの確定（11 月 30 日～ 12 月 5 日） a）作成したすべてのドキュメントのコントリビューションをクリーンアップする。 b）GitHub で作成したすべての pull リクエストをマージし、作成したすべての問題をクローズする。 c）最終プロジェクト レポートを完成させ、Google にレポートを送信する。
VII. 今後の成果物
Google ドキュメント 2020 シーズンの後も、引き続き LORIS のドキュメントに貢献したいと思います。具体的には、新しいリリースのドキュメントの更新と作成が継続できるかどうかについて LORIS のデベロッパーと話し合いたいと思います。また、Google シーズンの Google ドキュメント プロジェクト中に作成したドキュメントを確認し、改善の余地があるかどうか、確認させていただきたく存じます。最後に、関連するエンジニアリングの経歴があるので、今後 LORIS ソフトウェアの他の側面（ソフトウェア開発など）にも貢献したいとも思っています。