本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- INCF
- 技術撰稿人：
- hq
- 專案名稱：
- LORIS 訓練文件：開放可重現的神經科學
- 專案長度：
- 長時間跑步 (5 個月)
Project description
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 維基的說明文件，方便您閱讀文件。同時，該專案可能會提供資料庫圖，以傳達資料關係及改善架構視覺化。最後，這個專案會更新和改善內容，讓使用者瞭解 LORIS、開放科學背景和用途。
IV. 專案個人優勢
過去幾年，我參與了多個技術專案，因此在技術寫作方面擁有豐富的經驗。具體來說，我曾在多個團隊專案中負責撰寫文件，因此我相信自己在使用技術寫作工具 (例如 Read the Docs、Sphinx、Mkdocs、Markdown、LaTeX 等) 方面擁有足夠的經驗。此外，我先前在科學、技術、工程和數學課程的授課經驗，也讓我提升了技術溝通技巧。透過 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 軟體的其他部分，例如軟體開發。