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