本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 铃铛
- 技术文档工程师：
- 偏高开尔文
- 项目名称：
- 知识库
- 项目时长：
- 标准时长（3 个月）
Project description
概要
知识库是一个集中存储、整理和共享信息的集中存储库。对外使用时，用户可在知识库中了解关于公司产品或服务、组织和行业的任何必要信息。另一方面，内部知识库通常用于让社区/用户在内部展开协作和传播公司的所有知识和信息。 虽然特定知识库的内容取决于多种因素，但大多数情况下通常都包括有关如何开始使用特定产品、如何充分利用高级功能以及解决常见问题的信息。创建并向受众群体展示知识库的主要好处是，您可以按需为受众群体成员/用户/社区提供深入、即时的信息和答案，而无需单独执行此操作。
Mautic Knowledgebase 是一个中央资料库，提供有关 Mautic 相关主题的教程、方法指南和最佳实践。这些内容包括直接（例如在 Mautic 中做事情）或间接（例如更笼统的营销策略）。
在撰写本文时，Mautic Knowledgebase 还处于起步阶段，尚未完全完成，而 Mautic 社区希望利用此项目改进其向用户文档提供深入、按需信息的方式，使最终用户能够在使用 Mautic 时获得顺畅的体验。 学习 Mautic 知识库的内容非常丰富，但需要更新的教程和方法指南，还需要创建新的知识库以及匹配 Mautic 3x 版本的教程。
在浏览现有文档时，我的第一印象是 目前，您可以在 https://kb.mautic.org/ 上访问 Mautic Knowledgebase。文档中的某些教程、方法指南和最佳实践主题并非最新内容，而且内容十分稀少或不完整，也未涵盖当前版本的信息。
为什么您提议的改进措施会优于我当前想贡献的领域？ 改进建议旨在提高和确保效率、一致性，并让最终用户安心无忧。其中包含书面教程、方法指南和最佳实践及其相关图片，包括有关如何使用最新、易于浏览且易于理解的最新版、最新、易于浏览的每项功能的说明和说明。
按需
Mautic Knowledgebase 使用 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 日）
- 提交项目报告和导师评估
- 撰写并提交我参与 Google 文档季的经历。