本文讨论了 Google 技术编辑 Mike Pope 的职业生涯,涵盖了他从技术作家转变为编辑的经历,以及技术文档行业对编辑的需求和重要性。
Google 技术编辑 Mike Pope 加入了我们这一期的 Knowledgebase Ninja 播客,分享了他长达 30 年的技术文档之旅、他从技术作家到技术编辑的转变、不断增长的需求以及对专门技术编辑的需求。文档行业。在这里查看所有其他剧集。
主要事实
Mike Pope 的LinkedIn
Mike 从 20 世纪 80 年代起就开始创建技术文档
迈克在微软工作了十七年
十五年前,迈克从技术写作转向编辑
迈克在没有编辑的情况下度过了他职业生涯的最初七年
谷歌主办国际作家大会
要点
Mike 在 Google 云部门担任技术编辑
当一个文档机会出现时,Mike 正在从事支持和培训工作。这个机会似乎很有趣,所以迈克抓住了它,并开始了他在西雅图一家小型数据库公司的旅程。不久之后,Mike 开始与业内一些最好的公司合作,例如 Asymetrix、Microsoft、AWS(他在其中负责安全文档)、tableau 和 Google
在微软,迈克在开发部门工作,此时迈克从作家转变为全职编辑
谷歌云部门专注于企业解决方案,因此文档主要关注开发人员和工程师。谷歌保持工具的集成,将所有利益相关者,尤其是作家和开发者聚集在一起。作者撰写、暂存文档、获得批准,然后将其发布到一个将所有文档收集在一处的巨大仓库中
AWS 云提供许多不同的服务,作者的工作根据用户和目标受众而有所不同。尽管,生成质量文档的最终机制保持不变
在谷歌,有集中的工具来管理工作流程,但每个小组都可以独立发布。他们可以选取文档,创建或编辑它,获得批准,然后将其放入库中进行发布。这就是多个出版物同时发生的方式
迈克说,技术作家没有机会与专门的编辑一起工作。通过编辑,您有一套明确的职责
在 Google,编辑是帮助作家表达想法的团队合作。除了要遵循的关键写作细节之外,还有文档继承和目标的一个方面。问题是否表述清楚?目标受众是否从一开始就确定了?
技术写作和编辑中有一个“快速失败的概念” ,这意味着读者应该在第一段中知道文档是否回答了他们正在寻找的问题。作者的主要目标应该是尽量减少读者花在文档上的时间
为了改进文档,对概念内容模型、教程、参考文献、文档等进行了分类,以便读者知道在哪里可以找到特定信息
技术作家应该有一个风格指南,也称为文档警察。它包含几个基于研究的预先制定的决策,概述了使用哪些术语和不使用哪些术语
使用包容性语言是技术写作的关键因素。行业中有一些标准术语由于某些原因而令人反感。例如,术语“白名单”和“黑名单”——造成了一种让人们感到不舒服的二分法。因此,它已被替换为“允许列表和阻止列表”
编辑帮助作家改进,因为编辑过程具有教育意义,并在整个组织内传播优质写作文化
创建文档时要考虑的重要因素是:文档试图解决什么问题?您在与谁交谈/谁正在使用您的文档?
有多种方法可以了解您的文档是否有效:指标、通过支持渠道提供的消费者反馈、错误报告以及直接客户反馈
使用一致的词汇和短句编写的内容无疑会鼓励参与。因为它不仅对目标受众有用,而且对不熟悉技术语言的人也有用
Google 的文档经过彻底的内部分析。这些信息可在集中分析站点中获取(类似于 Google 上的外部分析站点)
分析有助于决定冰箱文档的命运。这些是尚未更新并保存在更大数据库中的文档
谷歌云文档的大部分流量来自有机搜索
在迈克职业生涯的初期,没有编辑,只有同行评审员。第一次与训练有素的编辑一起工作的经历让他大开眼界。他了解需要一位了解技术写作及其目标的专业人士
谷歌每年都会召开一次内部作家会议,来自公司各地(消费者、设备、云等)的所有技术作家都会参加。迈克很感激他能在那里与迎合不同受众的人们建立联系,这有助于拓宽他的视野
迈克最大的影响
Irma S. Rombauer—— 《烹饪的乐趣》的作者
《烹饪的乐趣》是 Irma S. Rombauer 于 1931 年撰写的一本烹饪书。 Mike 承认这本烹饪书的创新解释、清晰的程序、扩展的注释、警告和有效的用户插图对他的技术写作生涯有很大帮助。
关键资源
谷歌风格指南
迈克会给 20 岁的自己哪些与文档相关的建议?
迈克希望年轻时的自己知道,人们不会阅读文档,而是会浏览文档,寻找能够解决当前问题的特定信息;所以他可以少写一些,但要有针对性。
订阅忍者知识库
苹果
Spotify
RSS