本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- LLVM 編譯器基礎架構
- 技術文件撰寫者：
- DR87
- 專案名稱：
- 重組 LLVM 說明文件索引和說明文件樣式指南
- 專案長度：
- 標準長度 (3 個月)
Project description
這項專案包含下列工作：
a.) 重新建構說明文件索引頁面，提供更容易使用的服務。這項工作包括評估目前的網頁，並根據獨立研究、主題專家訪談和使用者意見調整網頁結構。可能的選項包括：修改簡短說明、調整現有頁面架構，以及/或透過漸進式資訊揭露模型新增其他圖層 (頁面)。後者可減少主要索引頁面上的連結數，讓使用者更容易找到特定資訊/指南。舉例來說，索引可能包含 LLVM 設計與總覽、使用手冊、子系統說明文件和開發程序說明文件的個別網頁連結。
b.) 更新開放原始碼貢獻者的 LLVM Sphinx 樣式指南。這項工作包括評估現有指南、透過獨立研究和主題專家訪談找出落差，以及根據雙方同意的條件更新指南。更新內容可能包括重新編排指南的版面配置、新增內容，以及插入貢獻者指南等相關頁面的連結。最終目標是方便志工盡快開始貢獻內容。