Moja 全球项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：

moja global

技术文档工程师：

Anthony

项目名称：

报告工具代码文档

项目时长：

标准时长（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) 目标 帮助系统工程师运行新安装的报告工具实例

4.3) 格式说明一篇操作方法文章，其中规定了系统集成商必须执行的一组顺序步骤，以便在运行的报告工具实例上上传和处理 Flux 输出数据库。

操作指南 在报告工具中载入和处理通量输出数据库

5) 用户指南

5.1) 目标受众群体最终用户

5.2) 目标 帮助最终用户了解嵌入报告工具中的不同功能以及应如何使用这些功能。

5.3) 设置方法文章的格式，该文章规定了最终用户为正确使用报告工具功能而必须采取的一组连续步骤。

6) 开发指南

6.1) 目标受众群体：程序员

6.2) 目标帮助最终用户了解报告工具中嵌入的不同功能以及应如何使用这些功能。

6.3) 格式参考文档，其中介绍了： a)构成该工具的主要设计元素 b)上述元素的功能分解 c)功能分解元素的执行元素 d)该工具的源代码 / 库组织 e)持续改进的长期愿景和方向 f)下一步合理的改进领域

以及一个简短的教程，介绍了如何根据用户的具体情况调整代码