Starnix 是複雜的元件,開發時有許多細微的面向需要注意。許多人需要處理 Starnix 的程式碼,即使他們不屬於 Starnix 團隊也是如此。與其個別教導每個人這些細微的層面,不如建立更多說明文件,並更常將人員導向這些文件。希望使用者會從文件中尋找資訊,進而促使我們撰寫更多說明文件,形成良性循環。
根據文件回答問題
每當 Starnix 團隊收到有關 Starnix 運作方式或如何開發 Starnix 的一般問題時,我們應撰寫涵蓋該主題的文件來回答問題,然後將提問者導向該文件。這種做法會產生文件涵蓋範圍完美的錯覺,因為文件是「及時」建立,可滿足提問者的需求。
這種做法會產生許多小型文件片段,無法整合為完整的文件。隨著這些片段累積,我們應將其重構為更全面、更有條理的文件。與從頭撰寫文件相比,這項重構程序較為簡單,因為目標不是在文件中新增更多資訊,而是改善現有資訊的組織方式。
實用步驟
- 找出問題:在聊天室中輸入一段說明複雜主題的文字時,請先暫停。
- 建立檔案:在
//docs/development/starnix/中建立檔案。 - 貼上並潤飾:貼上說明。新增標題和一句背景資訊。
- 更新目錄:在
_toc.yaml檔案中新增新文件的項目。詳情請參閱「更新網站導覽和目錄檔案」。 - 發布:上傳 CL。將連結傳送給要求者。
- 稍後再重構:不必擔心是否完全符合。將知識存入存放區是首要任務。
如要進一步瞭解如何建立說明文件,請參閱「為說明文件貢獻內容」一文。
不完整的文件
一份粗略但重點明確的文件,勝過沒有文件。如果文件很短,或未涵蓋所有可能的極端情況,請別擔心。如果回答特定問題,可以將問題做為文件標題。
機構
建立新文件時,您不必擔心要在文件階層中找到最適合的位置。您可以將檔案新增至頂層 starnix 目錄或一般 concepts 目錄。隨著文件數量增加,我們可以將文件整理成更有架構的階層。
程式設計代理程式
此外,這個方法也會產生對程式碼庫的編碼代理程式有用的文件。與人類相比,這些程式碼代理程式更需要這份文件,因為程式碼代理程式較難向人類提出即時問題。