本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織:
- 開放原始碼地理空間基金會
- 技術撰稿人:
- flicstar
- 專案名稱:
- 查看 OSGeoLive 快速入門課程
- 專案長度:
- 標準長度 (3 個月)
Project description
目的
- 更新文件,確保內容符合現況、準確且相關。
- 建立範本,確保文件中的內容保持一致,並用於日後新增的新快速入門導覽課程。
目標對象
- OSGeo 新使用者上線
- 新版 OSGeo Live 快速入門導覽課程的作者
外送
- 維基
以下是我認為需要完成的事項:
- 完成 50 個現有的 OSGeo Live 快速入門課程
- 標記要編輯的內容。送交審查。
- 實作評論/意見回饋
- 建立快速入門導覽課程範本,為未來導入一致性。
- 更新「如何執行快速入門程序」。
- 將新應用程式新增至 OSGeoLive - 需要快速入門。
我建議採取以下行動:
查看 50 個現有的 OSGeo Live 快速入門指南,並在這些頁面中標示要修改的內容,做為參考:
新:https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
舊版:https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
在 Trac (問題追蹤器) 中建立說明文件問題
提供結果摘要報告。例如,50 個項目中,有多少需要進行最少、中等或大量的工作。
建立快速入門範本,以便日後實作一致性。
更新「如何記錄快速入門檔案」頁面。
SoD 最終課程內容:
- 在 Trac 中提交 50 張文件工單,並根據約定的快速入門範本標示快速入門課程
- OSGeo Live Quickstarts 目前的狀態快照,以及更新這些內容所需的工作量。
- 更新版快速入門導覽課程範本,與訓練指南範本保持一致。
- 更新的快速入門導覽課程說明文件程序。
我會從以下步驟開始:
- 查看 OSGeo-Live 套件試算表,瞭解不同版本之間有哪些套件異動。
- 請向 OSGEo Live 郵寄清單詢問,他們是否有建議的特定快速入門課程。
我已完成以下操作:
- 設定我的 VM 並安裝 OSGeoLive
- 分支 OSGeoLive-Doc 存放區
- 取得 trac 存取權,並查看一些現有的文件支援單。問題單 #1382 似乎與此相關:https://trac.osgeo.org/osgeolive/ticket/1382
- 已參與郵寄清單討論
- 曾經進行過幾次非正式的視訊聊天