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