Julia Language 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：

Julia 語言

技術文件撰稿者：

mkg33

專案名稱：

科學機器學習的統一說明文件

專案長度：

長時間放送 (5 個月)

Project description

我希望能統合 SciML 組織，因為這個領域還有很大的改善空間，而完成這個專案無疑會為 Julia 程式設計師和 SciML 的活躍貢獻者/維護者帶來即時的好處。分散在 SciML 中的套件提供了一些非常實用的工具，但使用者也可能因為找不到包裹，無法發現包裹，無法察覺，而有危險，原因就在於使用者無法發現包裹，並套用到手邊的問題。

這個套件的主要用途在於觸及廣大的程式設計師 (無論是新手還是專家)，因此這實在很令人失望。為避免發生上述情況，我建議徹底修訂 SciML 說明文件的「首頁」，並建立某種中心，方便使用者瀏覽相關套件，並探索不斷擴大的生態系統。我們也建議參考這些資料，為資深使用者提高工作效率。

首先，所有個別套件的現有文件都需要修訂，以解決最基本的文體問題 (例如拼字、標點符號、文法等)。為確保樣式一致，SciML 需要具體的樣式指南 (對於回溯變更和日後參考都不可或缺)。從頭開始會浪費時間。而是以現有的 Julia 慣例為基礎，並納入有關 SciML 相關問題的全新內容。

完成樣式指南後，我打算在專案的第二階段修訂目前的文件。這樣說明文件看起來會更專業、更穩定。我已建立了幾個提取要求，說明我處理這項工作的做法。在這個階段，我還打算開發及導入高效率的引用系統，第一項工作是更新過時的參考資料頁面。

第三階段可說是最重要的階段，將設計 SciML 路線圖，強調分散套件之間的互動。兩個套件之間的關聯性越強 (相對於問題或程式碼本身)，在「參考資料」清單中顯示的順序就會越接近。我建議建立兩個建議鍵：一個用於程式碼相似度，另一個用於問題相似度。這樣一來，使用者就能更快速地找出其他可能實用的套件，而不用費力瀏覽各個存放區和文件。與其列出套件中的所有可能連線，我更希望專注於較大的套件，並試著透過較小的套件來呈現連結 (這個方法也會延伸以更新教學課程，以便指出與其他套件的連線)。這種做法可確保「參考資料」清單提供實用資訊，而不會列出所有套件組合。