本文讨论了 AMD 技术写作经理 Kavitha Kandappan 的技术写作流程与最佳实践,分享了如何确保文档质量及满足用户需求的经验。
AMD 技术写作经理 Kavitha Kandappan 与我们一起参与这一集的知识库忍者,讨论处理文档的最佳方法。
Kavitha 从事技术写作已有 17 年
卡维莎的一位邻居问她是否懂英语,她主动提出帮助他完成一些技术写作。从那里,她了解了用户手册,同样在事先不了解他们所使用的工具的情况下,这就是她的技术写作之旅的开始。
Kavitha 目前是 AMD 的技术作家。她与 CPU 工程师合作,为合作伙伴、客户和用户开发宣传资料。 Kavitha 确保他们遵循文档最佳实践,AMD 正在满足用户的需求,并且他们的消息简洁、清晰且易于理解。
您无法直接衡量文档投资回报率
Kavitha 进一步阐述了这一观点,他说你无法给出文档如何支持用户需求的数字。衡量文档成功时要问的几个问题是:
我们是否减少了支持电话的数量?
我们的文档产生了多少次点击?
最重要的是,您必须在客户使用您的网站时征求他们的反馈。这是您可以接近衡量文档投资回报率的方法。
Kavitha 的文档审核流程
Kavitha 制定了衡量文档质量的流程。一切都通过 Kavitha 和法律团队进行,以确保遵守品牌准则。
审核过程很困难,您必须考虑语言以及如何将语言传达给客户和用户。您还必须确保这些流程到位,以确保质量和沟通。
Kavitha 对年轻技术作家的建议
当谈到文档时,你永远学不够!当您查看产品和客户体验时,总会有一两件事让您无法理解。
除非您了解用户是谁,否则您无法向他们提供他们想要的东西。你应该公正地对待你的用户,而不是总是为产品经理和工程师定制你的工作。她精彩地补充道,您的客户就是您的内容用户!确保在满足工程师和产品经理的需求和愿望之前满足他们的需求。