本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Mautic
- 技术文档工程师：
- Swati Thacker
- 项目名称：
- 查看和更新 Mautic 的最终用户文档
- 项目时长：
- 标准时长（3 个月）
Project description
我对现有文档的第一印象是：
目前，文档很多，很多地方都很长、内容重复、不完整且无序，这可能导致用户难以找到所需的信息。
作为初次使用的用户，我无法理解 Mautic 的不同元素（例如广告系列、素材资源、消息、类别等）是如何结合起来满足业务需求的。我提议提供一个高级概念性主题，用 2-3 行来描述每个 Mautic 元素。此主题又可以链接到上述各个元素的各种详细任务主题。
贡献指南可以进行扩展，通过提供指向论坛、Slack 频道和 Git 代码库的链接，添加更多信息，例如如何提出问题、如何提出新内容/建议、报告 bug/问题/安全漏洞等。此外，样式指南需要扩展，以添加标准的排版惯例以及针对图片、表格等的准则。
而且，“电子邮件”和“广告系列”中有很多信息不完整，而且还有许多过时/需要更新的信息。
我要贡献的领域：
在 Slack 频道（用户直接与 Mautic 社区互动）上讨论相关讨论时，我意识到活动和电子邮件是 Mautic 的关键要素。使用适用于版本 3 的 Mautibox 时，我测试了关于“广告系列”的文档，发现它需要大幅改进。下面是我发现的一些问题以及我针对每个问题的建议：
- Mautic 用户在制作广告系列时，可以从各种操作、决策和条件中进行选择。许多操作和决策都缺少相关文档，但几乎没有广告系列状况的文档。我们需要识别缺失的信息，并将其添加到最终用户文档中。
- 广告系列可以很简单，也可以很复杂。对于首次制作广告系列的用户，当前文档没什么价值。我建议确定一些使用场景（简单和复杂），并创建示例工作流程（以分步教程的形式，或者以最终用户指南或演示视频中的主题的形式），以供首次用户在开始制作广告系列之前进行参考。
- 此部分信息需要以更有条理、更有序的方式呈现。必须遵循任务和基于概念的方法，以提高易用性。主题可以使用表格来展示有关操作、决策和条件的信息。“使用日期触发器”这个主题有点不合适。它可以嵌套在“条件”下。
除了宣传活动外，我还针对界面测试了电子邮件文档。我建议改进以下方面：
- 电子邮件的动态内容可用于自定义代码电子邮件模板（同时适用于“模板”电子邮件和“细分”电子邮件），但目前还没有相应的文档。添加详细说明动态内容的功能和设置方式，并附上一些示例。
- 为 Monitoring 电子邮件添加单独的主题。这可能包括有关如何使用信息中心内提供的电子邮件微件的信息，以及如何使用它们来跟踪与电子邮件相关的指标和活动。此外，请将与跟踪电子邮件相关的信息移至此处。
- 本文档并未说明联系人回复、退信管理、邮件所有者是全局配置设置，可以在“电子邮件设置”下进行配置。所有“电子邮件”设置都应归入一个整体主题。此外，许多其他电子邮件设置（如默认频率规则和退订设置）根本不会记录在内。说明哪些设置是必需设置或可选设置。
- 在“跳出管理”页面中，移除所有关于网络钩子的信息，并将其放入针对网络钩子的单独主题中。然后，我们可以在此处提供指向该主题的链接。
此外： - “信息中心”主题包含的关于可用微件的信息不完整。此信息非常重要，需要添加，因为这些信息可帮助用户分析和监控其 Mautic 资源。
需要整理整个文档才能发现不足之处。我们需要做出改进，使文档更易于用户阅读。
我期望自己的知识/经验对这个项目有何助益？
在解决了 Mautic 文档中的各种问题（包括在过去一个月内添加了对最新 Mautic 3.0 版本的支持）后，我熟悉了最终用户文档的结构，并发现文档中的不足之处。我花时间研究了其他营销自动化工具的文档，并将其与 Mautic 最终用户文档进行了比较，以了解如何在我们的文档中弥补这些缺失。 我熟悉 HTML 语言、开源工具和流程也是一个额外的优势。 我目前正在攻读用户体验研究课程，可以运用这些原则创建更面向用户的文档。此外，我具备信息架构方面的经验，能够整理内容并提出一些思路，使我们的文档能够契合用户目标。 此外，我还擅长拓展新技术领域的知识。我拥有 10 年的技术写作经验，以及我之前在 GSOD 期间为我从未接触过的技术领域的组织成功完成项目的经验，我相信我能为自己对 Mautic 文档的贡献做出贡献。