本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- LLVM 編譯器基礎架構
- 技術文件撰稿者：
- DR87
- 專案名稱：
- 重構 LLVM 說明文件索引和說明文件格式指南
- 專案長度：
- 標準長度 (3 個月)
Project description
這個專案包含以下工作：
a.) 重新調整說明文件索引頁面結構，提供更友善的使用者體驗。這項工作涉及評估目前的網頁，並根據獨立研究、專家訪談和使用者意見回饋，重新調整網頁。可行的選項包括修改簡短說明、重新建構現有頁面，以及/或透過漸進式資訊揭露模式新增其他層級 (頁面)。後者會減少主索引頁面上的連結數量，方便使用者找出特定資訊/指南。舉例來說，索引可能會包含 LLVM 設計與總覽、使用者指南、子系統說明文件和開發程序說明文件等不同頁面的連結。
b.) 更新 LLVM Sphinx 風格指南，供開放原始碼貢獻者使用。這項任務包括評估現行指南、透過獨立研究和專家訪談找出缺口，並根據已同意的規定更新指南。例如重新安排指南版面配置、加入新內容，以及插入貢獻者指南等相關頁面的連結。最終目標是讓志工更輕鬆地盡快開始貢獻。