本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 特尝试顿
- 技术文档工程师：
- 小戴
- 项目名称：
- 基本模块文档
- 项目时长：
- 标准时长（3 个月）
Project description
在此项目中，我建议查看并更新基本 Tryton 模块的文档。以下是用户在设置 tryton 系统时最常需要激活的模块。
对 Tryton 模块文档的改进将有助于用户找到符合其需求的模块，然后帮助他们设置和使用他们的系统。好的模块文档可让用户找到一些基本问题的答案，而无需在论坛上等待回复。
基本模块至少包括以下模块：account、account_invoice、account_invoice_stock、account_product、company、country、币种、派对、产品、购买、销售和库存模块。
tryton 文档主要有三种受众，用户、系统管理员和开发者。为了帮助定位其中每个模块，建议将每个模块的文档拆分为 doc 目录内的单独文件。这些内容可能包括包含以下内容的文件：模块目录和说明、设置模块的说明、关于如何使用模块的信息，以及关于模块的设计和结构的详细信息。根据模块的功能，其中某些文件可能不是必需的，您可以根据需要创建额外的文件。模块的改进将遵循我已为派对模块提出的建议：https://codereview.tryton.org/297241003/#ps327231002
以这种方式构建文档会获得很好的效果，因为文档目前是由 Sphinx 使用 reStructuredText 文件生成的。当我对文档进行更改时，这些更改会上传到 tryton 代码审核网站，以便对其进行审核，并且可以根据需要进行更新。如果每个人都对它们感到满意，就可以有希望获准加入 Tryton 了。