本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 特莱顿
- 技术文档工程师：
- dave
- 项目名称：
- 基本模块文档
- 项目时长：
- 标准时长（3 个月）
Project description
在此项目中，我提议审核并更新基本 Tryton 模块的文档。这些模块是人们在设置尝试系统时最常需要激活的模块。
改进了 Tryton 的模块文档，有助于用户根据自己的需求找到合适的模块，并帮助他们设置和使用系统。好的模块文档可让用户直接找到一些基本问题的答案，而无需在论坛上等待答案。
基本模块至少包括：account、account_invoice、account_invoice_stock、account_product、company、country、currency、party、product、purchase、sale 和 stock 模块。
Tryton 文档的主要受众群体有三类：用户、系统管理员和开发者。为了便于将文档定位到其中的每个模块，建议您将每个模块的文档拆分为文档目录中的单独文件。这些文件可以包含模块的目录和说明、模块设置说明、模块使用方式信息，以及模块设计和结构的详细信息。根据模块的功能，其中一些文件可能不是必需的，您可以根据需要创建其他文件。模块改进将与我为 party 模块提出的改进类似：https://codereview.tryton.org/297241003/#ps327231002
构建此类文档非常有效，因为文档当前由 Sphinx 使用 reStructuredText 文件生成。我对文档所做的更改会上传到 Tryton 代码审核网站，以便进行审核，我也可以根据需要对其进行更新。一旦大家对自己的作品感到满意，他们就可以获准加入试用计划。