本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 試用
- 技術文件撰寫者：
- dave
- 專案名稱：
- 基本模組說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
在此專案中，我建議您查看和更新基本 tryton 模組的說明文件。這些是使用者在設定 tryton 系統時最常啟用的模組。
改善 tryton 模組說明文件，可協助使用者找到符合需求的模組，並協助他們設定及使用系統。優質的單元說明文件能讓使用者找到部分基本問題的解答，不必等待論壇上解答。
基本模組至少包含：account、account_invoice、account_invoice_stock、account_product、company、國家/地區、貨幣、派對、產品、購買、銷售和股票模組。
tryton 說明文件、使用者、系統管理員和開發人員有三大目標對象。為協助您指定每一處的說明文件，建議您將每個模組的文件分割為文件目錄中的不同檔案。這些元素包括含有目錄目錄和模組說明的檔案、模組設定操作說明、模組使用方式相關資訊，以及模組設計和結構的詳細資料。根據模組的功能，這部分檔案可能非必要，而且也可以視需要建立額外的檔案。我已建議參與第三方單元課程，並參考這些改善項目：https://codereview.tryton.org/297241003/#ps327231002
以這種方式建構說明文件是很好的做法，因為 Sphinx 目前是使用 reStructuredText 檔案產生文件。我對文件做出變更後，就會上傳至 tryton 程式碼審查網站，以便進行審查，並視需要更新。只要大家都對自己的需求感到滿意，希望這些作品都能獲準加入 Getton 計畫。