本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- INCF
- 技術文件撰寫者：
- hq
- 專案名稱：
- 用於開放重現的神經科學的 LORIS 訓練文件
- 專案長度：
- 長時間執行 (5 個月)
Project description
I. 摘要
Longitudinal Online Research and Imaging System (LORIS) 是面向網頁的專案管理平台，適用於神經影像研究，支援多項 Open Science 計畫。說明文件在 LORIS 中扮演重要角色，具體來說，說明文件可協助 LORIS 使用者和開發人員瞭解軟體詳細資料，提高平台使用體驗或對軟體開發的貢獻。與此同時，LORIS 說明文件也應更新。這項專案旨在協助 LORIS 改善說明文件。
II. 目前狀態
LORIS 目前使用 GitHub Wiki、閱讀說明文件和 LORIS.ca 網站代管所有說明文件。具體而言，LORIS GitHub Wiki 代管了最多的 LORIS 說明文件，而額外的 LORIS 教學課程、簡報、使用手冊和逐步操作說明，均託管於許多平台 。目前的 LORIS 說明文件為 LORIS 開發人員和使用者提供指南，但對於進一步開發及整理資料，這能受益於進一步的開發及整理，特別是說明文件更新和技術細節。
III. 社群福利
改善 LORIS 訓練文件以用於開放可重現的神經科學，讓研究人員和開發人員受益於更容易使用的工具，進而改善研究的資料收集作業。具體來說，這項專案可能會更新及改善 LORIS 安裝/設定說明文件，以及為新使用者提供訓練的使用者教材。此外，本專案將協助遷移 LORIS GitHub 維基文件，並更新「閱讀說明文件」。同時，專案可能會提供資料庫圖表，說明資料關係並改善架構視覺化效果。最後，這項專案將更新及改善向 LORIS 介紹、開放科學背景資訊和用途的內容。
IV. 這項專案的個人優勢
過去幾年來，我參與了多項技術專案，並完成了技術寫作方面的穩固背景。具體來說，我曾負責撰寫多個團隊專案文件的文件，我認為我對於使用技術寫作工具 (例如閱讀文件、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 維基文件中的 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. 未來交付項目
在 2020 年 Google 文件季後，我想繼續對 LORIS 的說明文件做出貢獻。具體來說，我想與 LORIS 開發人員討論如何繼續更新及建立新版本說明文件。此外，我想花點時間查看我在「Google 文件季度文件」專案中建立的文件，看看是否有其他改進空間。最後，由於我擁有相關的工程背景，因此未來願意為 LORIS 軟體的其他方面做出貢獻，例如軟體開發。