特里頓專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：

Tryton

技術撰稿人：

dave

專案名稱：

基本模組說明文件

專案長度：

標準長度 (3 個月)

Project description

在這個專案中，我建議審查並更新基本 Tryton 模組的說明文件。這些是使用者在設定 Tryton 系統時，最常需要啟用的模組。

改善 Tryton 的模組文件，有助使用者找到符合需求的模組，並協助他們設定及使用系統。良好的模組文件可讓使用者找到一些基本問題的解答，不必等待討論區的回覆。

基本模組包含的最低單元數：account、account_invoice、account_invoice_stock、account_product、公司、國家/地區、貨幣、政黨、產品、購買、銷售和股票模組。

Tryton 說明文件的主要對象有三種：使用者、系統管理員和開發人員。為協助將說明文件指定給這些項目，建議您將每個模組的說明文件分割為位於說明文件目錄中的個別檔案。這些檔案可能包含目錄和模組說明、模組設定說明、模組使用方式資訊，以及模組設計和結構的詳細資料。視模組的功能而定，部分這些檔案可能非必要，而且可以視需要建立額外檔案。模組改善項目將沿用我先前為派對模組提出的改善項目：https://codereview.tryton.org/297241003/#ps327231002

說明文件目前是由 Sphinx 使用 reStructuredText 檔案產生，因此以這種方式建構說明文件會很實用。我會在說明文件中進行變更，並上傳至 Tryton 程式碼審查網站，以便進行審查，我也可以視需要更新說明文件。一旦大家都對他們感到滿意，就能獲準加入試用。