About

Civitas Learning 的玛丽讲述如何制作出色的文档

Author Tanmer Tanmer
Tanmer · 2025-06-09发布 · 0 次浏览

玛丽在知识库忍者播客中分享了她在Civitas Learning的技术写作经验,包括如何吸引和服务客户的文档最佳实践,以及她对用户体验写作的看法。

https://document360.com/blog/how-to-craft-exceptional-documentation-that-attracts-and-serves-customers/

Civitas Learning 的技术作家 Mary Connor 加入了我们这一集的知识库忍者播客,并谈论了吸引和服务客户的文档最佳实践以及令她兴奋的技术写作领域的创新。

主要事实

  • 玛丽的领英

  • Civitas 学习网站

  • 完成技术写作硕士学位后,她加入了一个研发实验室,担任技术作家,后来进入软件领域。

  • Mary 设计技术产品文档已有十多年了,自 2008 年以来一直专注于敏捷文档

  • 目前,她是 Civitas Learning 的用户、管理员和开发人员文档的孤独撰稿人。

要点

  1. 作为一名文档撰写者,她说她的主要工作是在纸上教人们。定位很大程度上是关于作为一名教师,比如说,分析受众,了解他们需要什么,弄清楚如何接触他们,如何想出隐喻来建立概念桥梁,他们需要去哪里等等。

  2. 谈到为最终用户编写良好的文档,她认为大多数人不喜欢阅读文档。因此,她创建文档时的主要目标是使其尽可能直观。就视觉而言,它并不真正意味着图片——它只是意味着有一个带有适当标题、表格、表格、图表等的结构,只要简单地看一下它,用户就会得到一大堆信息,然后走开,而无需坐下来阅读一切。

  3. 玛丽认为,内容密度是吸引客户的一个关键因素,内容密度是相关内容与明显内容的数量。例如,不要告诉人们单击打印按钮进行打印。为他们提供所需的信息。当他们的需求得到满足时,他们就会回来并吸引更多的人来观看内容。

  4. 在初创公司工作,在较小的环境中,事情更加动态,她了解协作的重要性。因此,在选择工具或定义流程时,她会选择她的团队喜欢使用的工具。

  5. 如果他们已经在工具库中建立了基础,那么策略将是找到一种方法来扩展他们已经所处的位置、他们已经习惯做的事情以及他们已经如何审查自己的内容和内容问题。

  6. 玛丽说:“根据我的经验,使用这些强大的稀有工具时最大的挑战是他们所使用的工具的组织孤岛。技术作家、产品设计师等使用一套其他人无法参与的不同工具,如果他们要改变工具,将会带来巨大的回报。”

  7. “在敏捷文档流程中,我想让每个人都参与其中,我想为每个人提供工具,并且我希望他们能够在单一来源见面”,她补充道。

  8. 在讨论 Civitas Learning 的文档流程时,她提到首要任务是获取新版本和覆盖范围,同时尝试完成迁移旧内容并将内容整合在一起的繁重工作。可能存在这样的情况:您可以查找一段内容,但可能有四个不同的版本,但没有人知道要使用哪一个或当前的版本。因此,在跟上发布的同时,还需要解决此类问题。

  9. 这个过程看起来就像玛丽在其他地方建立的那样,其中的优先顺序是不可知的。这就是我们今后处理发布的方式。

  10. 谈到技术写作领域的创新,最大的变化是我们所说的用户体验写作的兴起,以及作者绝对应该在那里帮助设计用户界面并管理她所说的一切语言的想法。这与国际化和本地化有关。

玛丽最大的影响:汤姆·约翰逊

他掌握了所有信息,并开始撰写我希望自己写的所有博客,他回答了每个人的问题,解决了所有问题,事实上,他在其他人没有做过的情况下推出了应用程序编程接口(API)培训巨大的。这就是我们大家所需要的。向他致敬,他是一个出色的榜样。

关键资源

  • Config,Figma 的年会。 Figma - 一个用于设计用户界面的工具,他们有大量与内容设计和用户体验写作有关的演讲。

  • 编写文档 (WTD) Slack 社区

玛丽会给 20 岁的自己哪些与文档相关的建议?

永远不要担心没有特定的领域或工程背景,因为事实证明它是我的超能力。此外,这意味着我具有非常高的用户同理心和意识,这使我能够编写更好的文档。不要对此感到不安全,就去做吧。

另请阅读:使用示例创建 API 文档的终极指南

订阅知识库忍者的评论:

  1. 苹果

  2. Spotify

  3. RSS

提交反馈

资讯 资讯

直达客 AI 知识库平台,助您快速构建企业AI知识库,提升团队效率,释放知识价值。

直达客 AI 知识库平台介绍

直达客 AI 知识库平台介绍

AI 赋能,知识直达!直达客 AI 知识库平台,助您快速构建企业AI知识库,提升团队效率,释放知识价值。

Author 926b
By 数字体验专家
发布:2025-05-26
赢得客户终身信任的客户支持策略

赢得客户终身信任的客户支持策略

本文探讨了在制定客户支持策略时需要关注的重要统计数据,强调良好客户支持对客户忠诚度的影响,并提供了提升客户体验的建议。

Author customer-support-strategy-data
By Tanmer
发布:2025-05-26