本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Open Collective
- 技術文件撰寫者：
- Anna e só
- 專案名稱：
- 改善一般說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
第一印象 常見的情況是，說明文件頁面經常提及沒有支援媒體 (影片、GIF、圖片) 的說明頁面，而同一章節的其他部分則有較完整的項目。舉例來說，「Edit Collective」是只有指示的，但「Add Fiscal Host」只包含支援的媒體。
在我瀏覽的網頁中，沒有使用 alt 文字屬性來描述媒體。如果螢幕閱讀器使用者或網路連線速度較慢，且任何媒體無法載入，缺乏圖片說明會妨礙使用者理解說明文件。
參考說明文件合併常見問題，以及瀏覽使用者介面的直接操作說明 (例如變更 Fiscal 主機)。由於說明文件介面中沒有目錄，因此使用者知道登錄記錄變更會帶來的影響，而且只想要客觀指示，他們可能就會將文件視為詳盡而太正切。
雖然技術說明文件的用語完全相同，但公開提供的樣式指南文件對於說明文件的撰寫方式太少。由於「貢獻」頁面會列出技術說明文件的一些貢獻，對於 Open Collective 和潛在貢獻者，都可以使用更完整的規範。
提案 我提議檢閱使用者說明頁面的內容，重新思考他們的簡報內容和目前的結構。
方法和時間軸 我想與社群合作推廣持續不斷的意見回饋週期，以改善 Open Collective 說明文件。
社區凝聚期間 (2019 年 8 月 1 日至 9 月 1 日)：認識 Open Collective 社群！訪談主要專案和既有專案的活躍成員，詢問他們目前的文件狀態 (報告 #1)。記下用於追蹤查詢和問題的所有內部系統，以及記錄在開放式收集文件 (報告 #2) 中的程序。評估現行版本中存在的潛在問題，並準備解決問題的計畫 (報告 #3)。
9 月 2 日至 6 日：首次提供意見回饋與調整週期，考量社群在社群交流期間發表的所有留言和建議。我們的計畫好嗎？是否有任何事情需要變更？(報表 #4)
9 月 9 日 - 20 日：參考文件中未填入的章節，開發概念驗證。公開風格指南草稿 (報告 #5)。
9 月 23 日至 25 日：將概念驗證送交評估 (封閉式群組)。
9 月 26 日至 27 日：在正式推出前，我們是否需調整概念驗證？需要更多時間嗎？請視情況調整。(報表 #6)
9 月 30 日 - 10 月 9 日：概念驗證正式上線。第二次提供意見 (公開群組)。
10 月 10 日至 15 日：最終的概念驗證評估和調整週期。(報表 #7)
10 月 16 日到 20 日：停止從事活動 [1]。
10 月 21 日至 11 月 23 日：《公開風格指南》定案 (報告 #8)。套用樣式指南中所有使用者說明文件頁面列出的所有指示 (報表 #9)。為社群提供各項操作評估報告，以及進一步建議 (報告 #10)。
專案時間長度可視需要延長。
[1]：在我的「文件」季別應用程式之前規劃行程。
交付項目 - 針對所執行的活動建立 10 份公開報告 - Open Collective 和外部貢獻者皆可使用的公開樣式指南 - 更新使用者說明文件頁面