本文讨论了 Mimecast 知识库经理 Colum McAndrew 的技术写作经验,涵盖了他如何进入该领域、与团队的协作以及文档改进的策略。
https://document360.com/blog/how-to-get-into-technical-writing-with-colum-mcandrew-of-mimecast/
Mimecast 的知识库经理 Colum McAndrew 与我们一起讨论如何在本期知识库忍者中进行技术写作。
在这里与 Colum 和 Mimecast 联系:
科勒姆·麦克安德鲁
模仿秀
要点:
Colum因意外陷入技术传播领域,现已拥有20年经验
Colum 被分配了一个一次性项目来整理一个项目的文档,该项目的文档记录很差,而在之前的职位上,他表现良好,后来全职进入该领域。
科勒姆在指导家庭驾驶时首次体验技术写作
科勒姆的家人需要从英格兰北部开车前往伦敦,在没有卫星导航的情况下,科勒姆写下了路线以便他们能够导航。这是 Column 第一次接触技术写作,也是他第一次意识到自己其实很擅长写作 。
产品与产品营销团队之间的整合
Colum 定期与产品和产品营销团队会面,以确保他们保持一致。与客户成功团队也有密切的关系,因为他们在第一线与客户交谈。
简化这些团队之间的沟通
这两个团队只需向特定的电子邮件地址发送电子邮件即可为文档团队创建 Jira 工作案例,这将创建他们的案例并订阅所有相关方,以确保可以跟踪该案例直至解决。
编写文档时始终打开产品
Colum 指出,在编写文档时向您开放产品的完整上下文非常重要。这可以提高您的写作水平,因为您可以通过以不同的方式使用您的产品来找到更好的解决方案来解决读者遇到的问题。
以知识为中心的内容
Mimecast 目前会在客户提出请求时向他们展示文章,如果这些文章还不够,客户会直接联系支持工程师……工程师将回复 Colum 的团队,分享文章如何未能解决客户问题。这使得文档团队可以改进这些文章,以减少客户遇到问题后的支持负担。
整合所收购企业的文档
Colum 的团队必须整合 Mimecast 收购的企业文档,这些文档从带有屏幕截图的 .pdf 到完整的 WordPress 网站不一而足。他提到了调整所有新内容的风格指南以确保一致的体验的重要性。
两位技术作家正在处理大约。每月 40 个工作案例
Colum 的两名技术作家团队每月处理大约 40 个新工作案例,尽管上个月他们处理了 67 个 - 这是有趣的一个月!
Colum 的 #1 文档相关资源
Colum 强烈推荐科学技术传播者协会创建的 Communicator 期刊:
ISTC 通讯器
订阅知识库忍者的评论:
iTunes
Spotify