本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- moja 全球
- 技术文档工程师：
- 阿东
- 项目名称：
- 报告工具代码文档
- 项目时长：
- 标准时长（3 个月）
Project description
鉴于有机会为 Moja Global 组织记录报告工具，我提议制作 6 种类型的文档，供不同的受众群体用来实现不同的目的。概述如下：
1) 环境设置指南
1.1) 目标对象群组 系统工程师
1.2) 目标帮助系统工程师为报告工具设置本地构建和执行环境。
1.3) 格式 方法指南文章，规定了系统工程师必须采取的一系列顺序步骤来设置有助于构建和运行报告工具的环境。
2) 制作指南
2.1) 目标对象群组系统工程师
2.2) 目标：帮助系统工程师从源代码构建报告工具组件
2.3) 格式指南文章，其中规定了系统工程师在获取和编译报告工具的源代码时必须执行的一系列步骤。
3) 安装指南
3.1) 目标对象群组系统工程师
3.2) 目标帮助系统工程师安装新构建的报告工具组件
3.3) 格式：方法指南文章，其中规定了系统工程师在新设置的环境中部署报告工具时必须采取的一系列顺序步骤。
4) 操作指南
4.1) 目标对象群组系统集成商
4.2) 目标：帮助系统工程师运行新安装的 Reporting Tool 实例
4.3) 格式：介绍操作方法文章，其中规定了系统集成商在正在运行的报告工具实例上上传和处理流动输出数据库时必须采取的一系列顺序步骤。
操作指南 在报告工具中配置和处理流动输出数据库
5) 用户指南
5.1) 目标受众群体最终用户
5.2) 目标 帮助最终用户了解报告工具中嵌入的不同功能以及如何使用这些功能。
5.3) 格式 方法指南文章，规定了最终用户为了正确使用报告工具的功能而必须执行的一系列步骤。
6) 开发指南
6.1) 目标受众群体计划员
6.2) 目标 帮助最终用户了解报告工具中嵌入的不同功能以及如何使用这些功能。
6.3) 格式参考文章，其中应描述以下事项： a) 构成该工具的主要设计元素 b) 上述元素的功能分解 c) 功能分解元素的执行元素 d) 工具的源代码 / 库结构 e) 持续改进的长期愿景和方向 f) 后续可以改进的逻辑
一个简短的教程介绍如何根据用户的具体情况调整代码