本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織:
- Julia 語言
- 技術撰稿人:
- sophb
- 專案名稱:
- 重新打造 FluxML 網站
- 專案長度:
- 標準長度 (3 個月)
Project description
這項提案旨在改善 Flux 的說明文件網站,讓其中的資訊有條理且吸引新手和專家。具體來說,我們的目標是將現有文件重新整理為新的章節,並為新手建立新的入門教學課程,擴充 Flux 60-mine-blitz 教學課程。
專案包含以下階段:
分析目前的說明文件網站:檢查現有資訊,並定義資訊的樣式指南,以便建立新的教學課程。
為資訊和入門教學課程定義新結構:與導師合作,決定說明文件網站的新章節,並重新安排章節順序。此外,請參考 Flux 60-mine-blitz 教學課程,定義入門教學課程的內容表,並在此基礎上進行建構。
重新調整資訊結構:根據上一個步驟中與導師合作時所定義的計畫,更新網站。
建立入門教學課程:撰寫初稿並查看初稿。取得導師的意見回饋。當我和導師判斷這份文件已完成最終版本後,就會將其發布至說明文件網站。
(選用) 將現有的說明文件從 README 轉換為 HTML:如果在完成四個主要階段後還有時間,我可以將現有的說明文件從 README 轉換為 HTML,方便使用者從網站存取。
為了達成專案目標,我將與 Flux 社群密切合作,瞭解現有的說明文件,並決定最佳做法。我是剛接觸 Julia 的新手,認為這個功能有助我們為全新的入門教學課程決定適當的資訊層級。
我會專注於確保我的工作有助於 Flux 社群導入新用途。此外,我也會專注於協助經驗豐富的使用者探索新的用途,並深入瞭解 Flux 的細節。