本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- 阿珠語
- 技術撰稿人：
- Shuo Liu
- 專案名稱：
- LightGraphs Docs 2.0 與使用者友善的 JuliaGraphs 教學課程
- 專案長度：
- 長時間跑步 (5 個月)
Project description
在這個長期專案中，我會改善 JuliaGraphs 中模組的網站和說明文件。具體來說，我的著作包括但不限於以下內容：
LightGraphs Docs 2.0 - 10 週
- 簡介：LightGraphs.jl 是針對 Julia 最佳化的輕量圖表套件，可做為 JuliaGraphs 生態系統的核心。即將推出的 LightGraphs 2.0 版代表 LightGraphs API 的重大變更。我會確保說明文件反映 LightGraphs 的最新功能。
- 成果：我會對現有的 API 文件進行稽核，看看哪些說明文件可以維持不變，並分析 2.0 版中所做的變更，確保這些變更已在文件中以範例的形式妥善記錄。在這個過程中，我會撰寫貼文來說明 2.0 版的重大異動。為協助新手學員對 LightGraphs 更清楚瞭解，我會製作初學者指南，引導他們開始使用 Julia 的圖表。
- 注意：在這個專案中，Documenter.jl 會用來產生文件，以建構 LightGraphs 文件。除了 Coloring.jl 等模組的 API 參照以外，我也需要這些子模組的 API 參照，例如 greedy_color.jl。我將探討如何新增這些模組來更新 LightGraphs 說明文件。此外，圖論是相當專業的數學領域，對沒有數學背景的人來說，這門學問很難理解。我從事學術研究已有 2 年，並在個人網站上撰寫許多部落格文章，因此我有信心在製作初學者指南時，解釋不同演算法的要點，並提供在各種情況下可使用的提示。
JuliaGraphs 教學課程 - 10 週
- 簡介：許多 JuliaGraphs 套件的說明文件都是以開發人員為對象。我會加入一些簡單的範例，並說明每項功能的用法，讓使用者更容易上手。
- 交付項目：我將進行現有 LightGraphs 教學課程的稽核，看看需要加入哪些材料，並示範各項功能的使用和動機。接著，我會按照 JuliaGraphsTutorials的方式，擴充 JuliaGraphs 教學課程，包括 LightGraphs 生態系統的新手指南。
- 附註：JuliaGraphs 教學課程的內容目前不夠完整，上述成果大多是針對 LightGraphs 套件。如果時間允許，我也會為 JuliaGraphs 中的其他模組新增教學課程，例如 GraphPlot.jl、MetaGraphs.jl 和 SimpleWeightedGraphs.jl。
JuliaGraphs Central 網站 - 4 週
- 總覽：JuliaGraphs 的中央網站提供生態系統套件的總覽。不過，這項資源仍以說明為主，可以進一步改進，成為初學者在 Julia 中使用圖表時的首選資源。我要怎麼用視覺化的方式突顯不同 JuliaGraphs 套件的特色？
- 成果：我會提供用途和範例，突顯 JuliaGraphs 套件的功能，並進行稽核，確保這些功能仍適用且受支援。我會建立一個專區，說明不同領域 (醫療保健、教育等) 中各種套件的不同用途。如果時間允許，我會研究圖表中使用的演算法，並提供視覺化說明。
- 附註：許多 JuliaGraphs 套件已廣泛用於不同領域。除了繪製 NetworkViz 的 DiGraph 等擴充功能，我還會納入其他特定主題的應用程式，例如生物學中的生物結構 MetaGraph、城市規劃中的交通分配 DijkstraState、教育領域中的 TreeView DiGraph 等。