本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Mautic
- 技术文档工程师：
- 开尔文
- 项目名称：
- 知识库
- 项目时长：
- 标准时长（3 个月）
Project description
摘要
知识库是一个集中存储、整理并共享信息的存储库。对外使用时，知识库是指用户需要了解的关于公司的产品或服务、组织和行业的任何知识。另一方面，内部知识库通常用于让社区/用户在内部进行协作和传播公司的所有知识和信息。 虽然具体知识库的内容会因众多因素而异，但大多数情况下通常都包含有关如何开始使用特定产品、如何充分利用高级功能以及解决常见问题的信息。创建并向受众群体展示知识库的主要好处是，它可让您为受众群体成员/用户/社区提供深入、即时的按需信息及答案，而无需逐一执行此操作。
Mautic Knowledgebase 汇聚了与 Mautic 相关的各种教程、方法指南和最佳实践，这些主题是直接的（例如如何在 Mautic 中做的），或是间接的（例如更通用的营销策略）。
在撰写本文之时，Mautic Knowledgebase 刚刚起步且尚不完善，因此 Mautic 社区希望利用此项目改进其按需为用户提供深度信息的方式，以便让最终用户在使用 Mautic 时获得顺畅的体验。 通过 Mautic Knowledgebase 学习了很多信息，但需要更新的教程和方法指南、制作新知识库，还要与 Mautic 3x 版本保持一致。
我对现有文档的第一印象是： 目前，您可以访问 https://kb.mautic.org/ 下载 Mautic Knowledgebase。文档中的一些教程、方法指南和最佳实践主题内容未及时更新、内容不完整或不完整，也没有涵盖当前版本的信息。
为什么您提议的改进与我当前想做出的改进相比？ 我们提议的改进措施是：提高效率、确保一致性，并让最终用户安心无忧。该课程将包含书面教程、使用指南和最佳实践及其相关图片，并包括有关如何使用新款、易于浏览且易于理解的最新版 API 各项功能的说明和说明。
按需
Mautic Knowledgebase 使用 Grav 平面文件 CMS 和 KLB4 主题编写。我研究了很多方法来改进知识库文档
项目目标
- 查看知识库。
- 请根据 Mautic 3x 的版本更新教程和方法指南。
- 为新创建的 Mautic Community Knowledgebase 创建资源
- 编写一系列方法教程和指南，帮助 Mautic 用户更有效地设置、配置和使用该应用。
- 更新视频教程以适应 Mautic 3x 版本。
- 移除过时的图片和信息。
- 重写知识库，使其更易于理解。
- 确保正确实现知识库文档的风格指南/模式
时间表
8 月 1 日之前
- 继续为组织做贡献。
- 更加熟悉知识库文档和当前版本的 Mautic。
- 学习新技巧和技术写作技能，帮助实施项目。
社区凝聚（8 月 1 日 - 9 月 1 日）
- 建立沟通渠道和时间（由于时差）
- 优化我的目标，并为双方设定预期
- 详细了解社区和产品
- 与导师及组织的其他成员讨论拟定的文档结构。
- 敲定建议的功能以及需要对现有文档进行的其他修改。
记录时间
- 第 1 周（9 月 2 日 - 11 月 22 日）
- 在此期间，我直接与我的导师合作，帮助大家：
- 查看知识库。
- 请根据 Mautic 3x 的版本更新教程和方法指南。
- 为新创建的 Mautic Community Knowledgebase 创建资源
- 编写一系列方法教程和指南，帮助 Mautic 用户更有效地设置、配置和使用该应用。
- 更新视频教程以适应 Mautic 3x 版本。
- 移除过时的图片和信息。
- 重写知识库，使其更易于理解。
- 确保正确实现知识库文档的风格指南/模式。
- 考虑到发布频率，因为开发团队会忙于发布次要功能
项目评估（2019 年 11 月 25 日至 11 月 29 日）
- 提交项目报告和导师评估
- 撰写并提交我参与 Google 文档季的体验报告。