本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 茱莉亞語言
- 技術文件撰寫者：
- Sophb
- 專案名稱：
- 改造 FluxML 網站
- 專案長度：
- 標準長度 (3 個月)
Project description
本提案旨在改善 Flux 的說明文件網站，確保其中包含的資訊結構良好，吸引新手和專家。更具體地說，我們的目標是將現有說明文件重新編排成新的章節，並針對 Flux 60-mine-blitz 教學課程的新手，建立全新的入門教學課程。
本專案包含以下階段：
分析目前的說明文件網站：稽核現有資訊並定義樣式指南 (以取得相關資訊)，以便建立新的教學課程。
定義資訊的新架構並開始使用教學課程：在說明文件網站中加入導師的共同決定新章節和重組。此外，以 Flux 60-mine-blitz 教學課程為起點，據此定義入門教學課程的目錄。
調整資訊結構：根據上一個步驟與導師合作定義的方案，更新網站。
建立入門教學課程：撰寫並檢查第一份草稿。取得導師的意見回饋。如果導師和我確定本文件的最終版本，我就會發布到說明文件網站。
(選用) 將現有說明文件轉換成 HTML 格式：如果完成四個主要階段後我還有時間，可以將 README 的現有教學課程轉換為易於存取的內容。
為達到這個專案目標，我將與 Flux 社群密切合作，瞭解現有文件並決定最佳方式。我自己是 Julia 新手，相信這有助你判斷新入門教學課程的正確資訊層級。
我會專注於確保協助 Flux 社群採用新做法。此外，我也會將重點放在協助有經驗的使用者探索新的用途，以及探索 Flux 更詳細的資訊。