このページは Cloud Translation API によって翻訳されました。

INCF プロジェクト

このページには、Google Season of Docs で承認されたテクニカルライティングプロジェクトの詳細が掲載されています。

プロジェクトの概要

オープンソース組織:: INCF
テクニカルライター:: hq
プロジェクト名:: オープンで再現可能な神経科学のための LORIS トレーニングドキュメント
プロジェクトの長さ:: 長時間実行（5 か月）

プロジェクトの説明

I. 概要

ロングスルーオンラインリサーチアンドイメージングシステム（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 ウィキから Read the Docs へのドキュメントの移行と更新を支援することも目的としています。一方、プロジェクトでは、データの関係を伝え、アーキテクチャの可視化を改善するためにデータベース図を提供できます。最後に、このプロジェクトでは、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 で作成したすべてのプルリクエストを統合し、作成したすべての問題をクローズします。 c）最終的なプロジェクトレポートを完成させ、Google に送信します。

VII. 今後の成果物

Google Season of Docs 2020 の後も、LORIS のドキュメント作成に引き続き貢献したいと考えています。具体的には、新しいリリースのドキュメントの更新と作成を継続する可能性について、LORIS デベロッパーと話し合いたいと思っています。また、Google Season of Docs プロジェクトで作成したドキュメントを見直し、改善の余地があるかどうかを確認したいと思います。最後に、私は関連するエンジニアリングのバックグラウンドを持っているため、今後、LORIS ソフトウェアの他の側面（ソフトウェア開発など）にも貢献したいと考えています。