當前階段:
2021 賽季文件計畫已於 2021 年 12 月 14 日結束,請參閱時間表。
本指南適用於申請或參加 2021 年季文件計畫的機構管理員。
貴機構是否應該參與 2021 年季度文件計畫?
這些問題可協助您瞭解開放原始碼專案或機構是否應參與「文件季別」計畫。
你的機構或專案是否:
- 認為全新或更新的說明文件有助於達成專案或社群中的目標,或是解決相關問題?
- 初步瞭解或假設如何評估文件專案成功嗎?
- 您是否願意協助社群成員招募、評估及培訓技術撰稿人,且在專案期間 (6 至 8 個月,包括報名期限) 可以回答問題並提供其他協助?
- 有社群成員願意擔任組織管理員,協調建立申請書、回覆計劃管理員的問題,並提交每月評估和最終評估和個案研究嗎?在 2021 年 Google 文件季度完成後,機構管理員也應願意填寫後續問卷調查。
此外,貴機構也應符合計畫資格規定,包括能夠建立開放式共同帳戶。
機構申請程序
探索階段
雖然 2021 年 Google 文件季度申請將於 2021 年 2 月 9 日開放申請,但我們強烈建議機構先花一些時間完成探索階段中的步驟,再提交申請。
- 建立專案提案頁面。提案頁面會列出關鍵需求、目標或問題、可能的說明文件解決方案,以及可能的指標。這個頁面應為公開網頁,並允許社群提供檔案和進行討論。針對有意參與的技術內容撰稿人提供資訊,他們該在哪裡提問、表達興趣,或進一步瞭解你的專案?(如需範例,請參閱專案構想清單)。
- 在社群頻道中發布您的提案頁面,並將您的組織新增至「Google 文件 GitHub 存放區」感興趣的機構清單。您也可以在「Write The Document Slack」頻道中,透過 #season-of-docs 頻道分享您的連結。宣傳與新聞網頁包含可用來談論「文件季別」的標誌和其他內容。
- 對於每項說明文件概念,請思考專業技術人員需要具備哪些經驗和資格,才能順利與您的社群和機構合作。您的社群能協助撰寫技術文件人員 (例如使用 GitHub 或文件工具鍊) 開發哪些技能?(請參閱與技術撰稿人合作指南)。
- 詢問自願者,回答感興趣的技術撰稿人問題。
- 如果有技術撰稿人想要合作完成專案,請著手審查他們提交的任何意願聲明。
應用程式階段
- 從提案頁面中選擇最具潛力的提案。每個機構組織只能提交一項提案。請考量以下事項:
- 哪個構想獲得技術撰稿人最關注?
- 哪一項構想有助於解決專案最棘手的問題?最好選擇效益較高的構想,比起說明文件專案更可能完成,但不會對專案造成顯著影響的想法。
- 這個想法是否要求社群的特定成員參與?學員是否有時間參與?
使用提案範本建立提案。 請務必瞭解並提供下列資訊:
- 您想要解決的問題
- 您希望改善或建立的說明文件範圍
- 如何評估文件成效
您的提案也必須包含預算。 系統不會將不完整的提案納入考量。
請在申請表截止日期 2021 年 3 月 26 日 18:00 (世界標準時間) 前提交申請表。 已接受的提案將於 2021 年 4 月 16 日公布。
專案開發與報告
專案啟動
- 如果貴機構已為專案挑選技術撰稿人或撰稿人,請與技術撰稿人聯絡。請與技術撰稿人合作,建立作業時間表和定期檢查進度。
- 如果您收到許多感興趣的技術撰寫者表示感興趣的意見,請公開公告您的技術作家選擇,或向申請者說明您的決定。
公益捐款
- 自 2021 年 6 月 10 日起,文件季度將在各機構的 Open Collective 帳戶中存入 40% 的補助金。我們建議機構依據專案里程碑 (包括專案啟動時付款) 與技術撰寫人員建立付款時間表。
- 其餘 60% 則會自 2021 年 12 月 14 日起,在機構完成並提交最終評估與個案研究的 Open Collective 帳號中存入帳戶。
- 如要進一步瞭解如何建立公開集合帳戶,請參閱付款指南。
專案狀態回報功能
- 機構管理員應在收到狀態報告表單連結後的一週內填寫每月狀態報告 (連結會透過電子郵件傳送,請查看垃圾郵件資料夾)。
專案最終評估和個案研究
申請機構必須在世界標準時間 2021 年 11 月 30 日 18:00 前完成專案最終評估和個案研究,並提交個案研究,才能獲得剩餘的資助資金。
最終評估
最晚一個評估表單,最晚會在世界標準時間 2021 年 11 月 30 日的 18:00 (世界標準時間) 前開放機構管理員使用。
個案研究
「文件季度」個案研究是貴機構參與《2021 年文件季度》中關鍵交付項目。保留每週專案更新記錄 有助於建立個案研究。每週記錄專案進度 (包括提取要求、問題或對話的連結,如果有的話)、表現良好 (或不佳) 的部分、您學到的事情,以及提問的問題。
詳情請參閱建立個案研究一文,並務必遵循我們的個案研究範本來建立個案研究。在最終評估表單中,您必須以連結形式提交個案研究。
您的個案研究將發布在「Google 文件」季網站,因此加入專案相關資訊時,請注意這一點。
我們要求各機構參與至少三次後續的後續問卷調查,方便我們長期追蹤「文件」季度專案的成效。
表單
表單 | 連結 | 期限 |
---|---|---|
機構申請 | 機構申請目前已關閉。前往 season-of-docs-announce 加入公告郵寄清單,隨時掌握最新消息。 |
2021 年 3 月 26 日 18:00 (世界標準時間) |
機構付款資訊 | 機構付款資訊階段已完成。如需變更貴機構的付款資訊,請洽詢文件季度管理員。 |
2021 年 5 月 12 日 18:00 (世界標準時間) |
技術寫作人員聘用證明 | 技術撰寫人員聘僱階段已完成。 |
2021 年 5 月 17 日 18:00 (世界標準時間) |
每月評估作業 | 查看時間表 | |
最終專案評估和個案研究 | 表單將於最終專案評估和個案研究階段 (2024 年 11 月 22 日至 2024 年 12 月 10 日) 提供。 |
2021 年 11 月 30 日 18:00 (世界標準時間) |
後續問卷調查 | 問卷調查階段可在後續問卷調查階段 (2025 年 5 月 1 日) 提供。 |
查看時間表 |
相關資訊
- 請參閱文件的季度時間表。