選取技術文件作者

目前階段:
結果公布時程

本頁提供開放原始碼機構的相關提示,說明如何評估及選擇適用於文件季度文件季度的技術寫入者。

簡介

開放原始碼機構必須聘請技術文件撰寫者處理他們提出的專案。機構必須自行取得技術文件撰寫專員。技術文件撰寫者如有興趣與參與文件季節合作的機構,可以前往 GitHub 存放區的季別,以及撰寫文件 Slack 的 #season-of-docs 頻道中。

開始這項程序

建議您盡快開始尋找技術文件撰寫專員,因為這項流程可能將在「說明文件季別」中推出。

評估技術文件撰寫專員

建議您向考慮的技術撰寫者索取先前開發過的說明文件範例,以便專注於評估他們的技術寫作技巧和經驗。

技術寫作技能和經驗

  • 評估技術撰寫者先前的經驗。在理想情況下,技術文件撰寫者應在為軟體業撰寫技術說明文件方面擁有一些經驗。《文件季》的目標之一,是讓技術文件撰寫專員有機會參與以開發人員為主的產品。因此,即使您的專案著重於開發人員目標對象,也不一定要具備 API、SDK 或其他開發人員平台的經驗。

  • 注重語言和溝通技能。 從這個觀點評估技術撰寫者先前的作品。最重要的是:您能瞭解作者撰寫的內容嗎?如果您想深入檢查技術撰寫者作品的語言,請確認標點符號和措辭是否一致、拼字正確和清晰易懂。措辭是否簡單或複雜?例如句子是否簡短,還是要一直顯示到難以理解為止?

  • 注意文件設計和版面配置。檢查文件範例的整體版面配置。設計符合邏輯嗎?您能輕鬆掌握文件或說明文件集的使用方式嗎?是否有重複內容或明顯的落差?

聘請技術文件撰寫專員

申請機構必須於 2022 年 5 月 16 日 18:00 (世界標準時間) 前聘請技術文件撰寫者,並完成下方的技術文件撰文證明表單。

技術文件撰寫者招聘階段結束。

聘僱前,請務必與技術文件撰寫專員討論薪酬付款時間表。我們建議機構根據專案里程碑 (包括專案啟動時的費用) 與技術文件撰寫專員訂立付款時間表。請記住付款日期,整個計畫中只會發生兩次,而在建立付款時間表時也只會發生金額。

注意:如果機構尚未僱用技術撰寫者,並在 2022 年 5 月 16 日 18:00 (世界標準時間) 前提交技術撰寫證明表單,將不會在首次撥款當天獲得資金。