本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 茱莉亞語言
- 技術文件撰寫者：
- mkg33
- 專案名稱：
- 科學機器學習的整合式說明文件
- 專案長度：
- 長時間執行 (5 個月)
Project description
我想努力推動 SciML 組織的統合，因為這個領域還有許多改善空間，完成這項專案之後，必定能為 Julia 程式設計師和積極參與 SciML 的活躍貢獻者/維護人員即時帶來助益。雖然分散在 SciML 的套件中提供了一些非常實用的工具，但也可能因為使用者無法發現包裹，並套用至手邊問題，因此可能造成這些風險 (尤其是新加入者)。
這並不代表他們感到困擾，因為套件的主要用途是觸及廣大的程式設計人員 (包括初學者和專家)。為了避免上述情況，我提議徹底修改 SciML 說明文件的「前端」頁面，並建立一種資訊中心，方便使用者瀏覽相關套件，以及探索持續成長的生態系統。對經驗豐富的使用者來說，這項功能可做為有用的參考依據，進而提高工作效率。
首先，所有個別套件的現有文件都必須根據最基本的樣式問題 (例如拼字、標點符號、文法等) 修訂。為了確保樣式一致性，SciML 需要提供具體的樣式指南 (無論是進行回溯變更或供日後參考之用)，從零開始實作這件事肯定會浪費許多時間。相反地，這個頁面以現有的 Julia 慣例為基礎，並納入 SciML 特定議題的新整段內容。
建立完風格指南後，我打算在專案的第二階段修改現有說明文件。讓說明文件更專業且穩定。我已經建立多個提取要求，用來說明我如何完成這個工作。在這個階段中，我還打算設計 (並導入) 高效率的引用系統。第一項工作是更新過時的引用頁面。
第三階段 (可說最重要) 將包含設計 SciML 藍圖，強調分散的套件之間相互作用。兩個套件之間的連貫度 (就問題或程式碼本身而言) 越強，「另請參閱」清單中應會越近。建議您建立兩個建議鍵：一個用於程式碼相似性，另一個用於有問題的程式碼。如此一來，比起費心瀏覽個別存放區和說明文件，使用者能夠更快找出其他可能有幫助的套件。與其列出套件中的所有可能連線，我比較想把重點放在較大的套件，並嘗試使用較小的套件來呈現連結 (這個方法也會延伸到更新與其他套件的連線應注意的教學課程)。這種做法可保證「一併查看」清單會提供實用資訊，而無須提供所有套件組合列舉。