與技術文件作者合作

目前階段：
「2019 年文件季別」計畫已於 2020 年 3 月 6 日結束。請參閱時間表。

以下是一些開放原始碼機構的規範，讓您瞭解如何與負責指導文件季度的技術寫作人員合作：

  • 向開放原始碼的世界和您的社群介紹技術文件撰寫者。
  • 協助技術寫入者使用參與專案所用的工具和程序。
  • 請詳細說明產品，讓技術文件撰寫專員對產品有明確的概念。這有助於技術撰寫者在為專案撰寫的內容上更有信心，且更具權威性。
  • 請說明目標對象的需求，也就是使用自家產品和/或其他產品使用族群的開發人員需求。
  • 與技術文件撰寫專員探討重要用途，協助他們設計必要的說明文件。
  • 在編寫文件前，逐步瞭解技術文件編寫者需要瞭解程式碼的時機。
  • 要求技術文件撰寫專員與必要的主題專家聯絡。亦即說明文件中涵蓋的產品各方面，負責的開發人員或其他專案貢獻者。
  • 確保技術文件撰寫專員能向各領域專家和其他社群成員取得所需的時間和資源。
  • 與技術寫入者合作，在相關文件中加入有意義的程式碼範例。

注意事項

《文件季》的開放原始碼導師不一定是技術文件撰寫專員，導師不需要具備說明文件技能。技術撰寫者將這些技能投入專案與指導關係。

他們改為分享開放原始碼社群、產品，以及開放原始碼專案使用的程序和工具相關知識。

導師關係的一大成果，是要在今年的說明文件季中，提供豐富且成功的體驗。有了愉快的使用體驗，在今年文件季結束後，技術文件撰寫者會繼續為開放原始碼專案貢獻心力，且其他技術文件撰寫者對於使用開放原始碼工作也會感到熱衷。