本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- DIPY
- 技術文件撰寫者：
- 阿雷莎塔里克
- 專案名稱：
- 整體重新架構和使用者焦點
- 專案長度：
- 標準長度 (3 個月)
Project description
我是軟體工程師，具備技術寫作專業知識。我有 4 年以上的經驗，具備撰寫高品質軟體文件、使用手冊、手冊和專案說明的經驗。我住在巴基斯坦伊斯蘭瑪巴德 (時區：UTC + 5)。我目前是實習生，預計在 8 月 18 日結束工作。 我參加過 Google 系列文件，擔任「OpenELIS Global」的技術文件撰稿人。原始文件的內容為法文、內容有限且已過時，因此我以英文撰寫了詳盡詳盡的使用者說明文件。我在 2020 年 5 月至 8 月左右在機構的 Perl & Raku 計畫中，擔任 Open Food Facts 伺服器的後端開發人員。除了後端開發之外，本實習的其中一個主要工作是建立 POD 格式的模組和函式說明文件。我去年進入了開放原始碼的世界，當時我還參與了幾個開放原始碼專案，隨後參加了 Google 系列文件。今年，我獲選參加旨在支援多元性的開放原始碼軟體和免費軟體。我的 Outreachy 專案是由 GitHub 代管，我對 Git 很有取向，而自 3 月起，我便定期為 Open Food Facts 和 Mozilla Fenix 貢獻心力。我是 Linux 3 年以上的 Linux 使用者，從那時起就一直使用終端機指令。
我目前使用的文件工具和語言包括 Sphinx、Read the 說明文件、Markdown。 我很喜歡這個想法，所以會努力運用，因為我有符合需求的經驗，也希望活用自己的知識和技能來為 DIPY 做出貢獻。我曾在數位圖片處理、電腦視覺和機器學習等領域擁有經驗。這有助於我更瞭解神經成像，並有助於製作說明文件。我在醫學領域擁有豐富的經驗。我為醫生、病患、勞工、救護車人員開發了一個醫療網站，我參與了醫生、病患、護理人員、實驗室助理和研究人員採用的其他系統。這樣一來，我就能製作觀眾更容易理解的文件。
我已瀏覽 DIPY 的說明文件，並在說明文件中記下了幾個瑕疵。我打算改善說明文件，裡面列出多個漏洞。 說明文件目前的狀態： 這份說明文件缺少具體的結構和設計 對於要瀏覽的新使用者來說特別費時 使用者很難從指南中取得資訊 文件內容需要改良 身為新使用者，我覺得這難以存取使用手冊和開發人員指南。需要調整說明文件的方式，讓使用者能夠輕易取得所需的資訊。說明文件缺乏一致性
我打算執行以下操作：
為說明文件定義具體的結構和範本 建立說明文件，讓使用者能夠輕鬆瀏覽並找到所需資訊 製作藍圖或工作項目清單，以便與社群互動 在進一步的說明文件作業作業中定義範本 定義貢獻指南和開發人員指南、開發指南、開發指南，以及改善專案內容的一致性，協助新使用者貢獻內容
使用手冊：
使用使用者指南時，我會著重於簡單明瞭的用語，以便使用者瞭解即使是最複雜的系統。術語、縮寫和其他內部資訊 (對於新使用者可能無法知道) 不會獲得改善。此外，我會特別介紹能讓使用者快速瞭解系統運作情形的圖片、加註螢幕截圖、圖像和影片等視覺內容。好的文件需要階層式標題和子標題，讓使用者瞭解每個部分會顯示的內容。此階層也應按照邏輯流程，幫助使用者以最實用的方式學習使用系統。這項專案的主要目標之一是建立無障礙內容。所有文件和指南均採用一致的樣式。請務必在多份文件中使用一致的字型和互補顏色。我一定會確保使用者能夠存取機構的更多資源，瞭解如何充分發揮系統的功用。
開發人員指南：
開發人員指南包含詳盡的指南和參考資料，可協助開發人員對 DIPY 原始碼做出貢獻。生成式 AI 會嘗試列出可用的各種選項，方便您根據目標選用合適的方法。 開發指南需要重新調整和架構。我要改寫開發人員指南的內容。其中包含建構依附元件、貢獻指南、風格指南、程式設計慣例、說明文件指南、安裝開發環境、偵錯、測試指南和相關內容，讓開發人員更容易使用。想要首次貢獻開放原始碼的貢獻者熱切參與專案時，必須將貢獻指南納入考量。因此，請保持內容清楚易懂、詳實且友善。貢獻指南是相當實用的文件，可用來瞭解民眾如何為開放原始碼專案做出貢獻。無論情況為何，對專案所做的貢獻都應盡可能簡單公開： 提交修正內容 回報錯誤 成為維護人員 討論程式碼的目前狀態 提出新功能建議
TEMPLATE
這個範本可用於捐款指南。你也可以根據文件規定修改內容，以及新增或移除區段。
提供給 DIPY
- 歡迎記事
TOC
行為準則
- 我們的標準
- 有助於營造正面環境的行為示例
- 參與者違反規定的行為示例
- 我們的責任
- 專案維護者的責任
- 範圍
行為準則的範圍
我需要知道哪些資訊？
如需程式碼參與方面的協助，我們的專案使用 [insert list of program language, frames or toolss]如果您還沒準備好提供程式碼，那也沒關係！此外，您也可以查看說明文件問題 [link to the docs label or tag on your Issue Tracker]，或有關設計問題 [link to design label or tag on your project track 問題]。 如果你有興趣參與程式碼，並想進一步瞭解我們使用的技術，請參閱下列清單。 加入資源項目符號清單 (教學課程、影片、書籍)，讓新貢獻者利用這些資源，瞭解使用者對專案的貢獻。
設定開發環境
在本節中，我將新增必須安裝的安裝程序和依附元件。執行安裝專案以安裝 $project
- 原始碼：github.com/$project/$project
- Issue Tracker：github.com/$project/$project/issues
如何提供內容
如何回報錯誤
- 提交錯誤報告前的注意事項
- 如何提交 A (良好) 錯誤報告？
如何提交變更
- 提取要求通訊協定
- 團隊回覆
- 回應速度
如何申請強化功能
- 提交強化建議前
- 如何提交 A 強化建議？
您的第一個程式碼貢獻
- 新手問題
- 協助解決問題 #### 提取要求
- 建立提取要求的程序
- 確認所有狀態檢查都通過。
如果狀態檢查失敗，該怎麼辦？
- 撰寫測試
- 測試涵蓋範圍
樣式指南
- Git 修訂版本訊息
- 標準樣式
支援
如果遇到問題，請聯繫我們。如果您需要協助，可以透過我們的郵寄清單發問，網址為 project@google-groups.com、IRC 即時通訊，或 [列出專案使用的任何其他通訊平台]。
授權
本節說明專案授權。
投入時間與溝通：
我每週可撥出 45 小時以上的時間，但若發生錯誤，我會在週末時補償。在社群凝聚期間，我將討論溝通方式，並決定每週與導師開會的時間、方式和會議時間。我會隨時讓導師掌握最新的工作資訊，並透過電子郵件將我的工作詳細資料分享給導師。我比較喜歡 TeamViewer，因為透過共用螢幕等許多功能相當容易使用。