陈浩——如何做一个好技术编辑
作者:李莹媚
什么技术写作技巧造就了一名优秀的科技编辑?虽然有些人可能看起来很明显,但其他人可能不是,并不是每个人都被这个潜在的有利可图的职业所吸引。陈浩是一名该领域打磨近十年的资深技术编辑,他将为我们揭开成功的技术编辑者会分享哪些技术、交流方法和技巧。
陈浩曾发表过多篇爆火的技术文章,例如《使用蒙特卡洛方案为奇异期权定价的观察》《selenium系统找不到指定的文件的解决方案》以及科普类视频《量化是什么?大叔谈量化》,他在金融和技术上有着非常深的钻研。与此同时,他还担任ItBase 第二届技术征文大赛的评审,帮助了广大技术爱好者学习原生分布式数据库相关知识,快速掌握的操作技能希望大家将学习体会、使用心得和实践总结分享给更多技术爱好者。
下面陈浩将分享几条技巧。首先,得具备一项基本的技术写作技巧:在所有技术写作技巧中表达清楚能力在技术知识必须掌握的。由于许多技术作者本质上是将复杂的专业信息转换为非专家和/或非用户的可用信息,因此他们必须能够使难以理解的信息易于消化和理解。这意味着要有一个清晰,简洁的写作风格,有利于学习和理解。
第二,要有意义的技术写作技巧。因为许多最成功的技术编辑和技术写作技巧与写作关系不大,而与技术知识有关,有多少技术作家根本不是从作家开始的。许多人从各个领域的技术专家开始,由于他们的技术和清晰写作的能力,在此过程中进入了技术交流领域。根据行业和工作环境的不同,这可以使任何给定的技术作家群体的知识库异常多样化或高度针对性。然而,一般来说,无论是在工作中还是通过自然设施学习,技术熟悉度都是成功所需的关键技术写作技能。
第三,长期成功的关键技术写作技巧:有效的沟通技巧。在探索技术写作技能组合时,似乎很容易忽视非写作技能,特别是因为技术文档可能会枯燥乏味。奇怪的是,正是出于这个原因,优秀的技术沟通者也需要具备扎实的口头和人际沟通技巧。技术写作最具挑战性的方面之一也可能是采访非交际主题专家(SME)。无论是由于缺乏沟通技巧还是办公室政治,中小企业都可能成为技术作家编辑过程中的一大障碍。有效的口头和人际交往能力是关键的技术写作技巧,需要从可能没有最佳分享技能的人那里挑选出有价值的信息。
关键技术写作技巧面试和倾听的能力对于技术写作技能提升也非常重要,它建立在应该已经很强的沟通技巧的基础上。太多经验丰富的技术传播专家,这些获取新闻的技能可能是最重要的技能。积极地倾听和深入的采访技巧可以帮助技术作者发现他们正在创建的文档的目标和设计考虑因素,他们正在使用的技术的功能和可用性,以及他们的受众和用户的需求。如果没有能力提出探究和适当的后续问题,技术作家不太可能确切地理解他们需要做什么或为什么。
此外,设计相关技术写作技巧技术传播者的关键技能经常被老派技术作家忽视,充分的设计技能正变得越来越重要,因为技术文档变得更加基于Web和可视化。无论是需要捕获屏幕截图还是高级插图,技术作者都需要能够以视觉方式传达复杂的过程,产品和概念。
最后,陈浩表示,成为一名优秀的技术沟通者需要学习高需求的技术写作技能,愿意寻找答案的持久和耐心的心态,以及创建专注于用户的文档的真正愿望。像大多数成功的论作者一样,最成功对于技术作者来说意味着“可用”文档是专注于读者需求和设施的文档。从概念到设计再到执行,优秀的技术传播者利用他们的技术写作技巧进行翻译,教学和解释。