目前階段:
「2019 年文件季別」計畫已於 2020 年 3 月 6 日結束。請參閱時間表。
本頁針對開放原始碼組織的指引,說明如何評估技術寫作專案提案,並在文件季選擇想指導的專案。
簡介
技術文件撰寫者提交了「文件季」提案,與所選的開放原始碼機構共同處理專案。Google 計畫管理員會將提案轉寄給開放原始碼機構,進行評估和選取專案。如要進一步瞭解相關步驟,請參閱機構組織管理員指南。
評估技術文件撰寫專員的提案
技術寫作技能和經驗
評估技術撰寫者先前的經驗。技術文件撰寫專員的提案包括他們最新的技術寫作體驗資訊。在理想情況下,申請者在撰寫軟體產業的技術說明文件時應具備一些經驗。《文件季》的目標之一,是讓技術文件撰寫專員有機會參與以開發人員為主的產品。因此,即使您的專案著重於開發人員目標對象,編寫者不一定要使用 API、SDK 或其他開發人員平台。
注重語言和溝通技能。 從這個觀點評估技術文件撰寫專員的提案。最重要的是:您能瞭解作者撰寫的內容嗎?身為導師,您的職務將協助技術撰寫者提供開放原始碼程序、工具與程式碼,您也不想查看產生的說明文件文字。如要深入瞭解提案的語言,請確認標點符號和措辭是否一致、拼字正確和清楚易懂。說法是簡單還是複雜?句子是否簡短,還是要一直顯示到難以理解為止?
注意文件設計和版面配置。在提案中,技術文件撰寫專員有機會提供他們開發的說明文件範例。檢查文件範例的整體版面配置。設計符合邏輯嗎?您能輕鬆掌握文件或說明文件集的使用方式嗎?是否有重複內容或明顯的落差?
提案
確認提案符合您的需求。 這項提案是否與你今年為「文件季文件」提交的任何專案構想相關?如果技術文件撰寫者提議新構想,請檢查該提案是否符合您的開放原始碼專案需求,並具備協助技術撰寫者實現該專案目標的合適人員。
尋找熱忱和周全。 提案是否證明技術文件撰寫專員對專案充滿期待?請考慮他們是否已將想法和實際措施納入提案中,方法是在探索階段諮詢貴機構,或是加入自己的想法,進而達成專案目標。
常見問題
Google 如何決定要提交多少專案?
只專心處理一或兩項專案。如果貴機構擁有的指導能力超過這個上限,可以提交更多。針對每個技術寫作,至少需要一位承諾僅為該專案的導師 (最好是兩位) 的導師。
閱讀有關說明文件季別運算單元分配的運作方式資訊。
如何選擇要接受哪些技術撰寫提案?
請務必選擇您收到的最佳技術撰寫者提案。也就是說,請選擇最符合您需求且最符合上述評估指南的提案。
我們需要在哪裡提交所選提案?
請參閱機構組織管理員指南。