超级高效技术写手的6个习惯

  浏览:1 巴克励步

我一直在思考一个问题:为什么有些团队的产品手册总能让人一眼看懂,而另一些却让人越看越糊涂?答案往往不在于工具,而在于写手的习惯。作为Baklib的研究员,我见过太多团队把产品手册建设当成一次性的任务,写完就扔,从不迭代。但真正高效的技术写手,他们把手册当作活文档,持续打磨写作技能、保持工作有序、深挖研究。这些习惯恰恰是构建优秀产品手册的基石。如果你正在为产品手册建设发愁,不妨从这六大习惯入手,利用B

超级高效技术写手的6个习惯
我一直在思考一个问题:为什么有些团队的产品手册总能让人一眼看懂,而另一些却让人越看越糊涂?答案往往不在于工具,而在于写手的习惯。作为Baklib的研究员,我见过太多团队把产品手册建设当成一次性的任务,写完就扔,从不迭代。但真正高效的技术写手,他们把手册当作活文档,持续打磨写作技能、保持工作有序、深挖研究。这些习惯恰恰是构建优秀产品手册的基石。如果你正在为产品手册建设发愁,不妨从这六大习惯入手,利用Baklib这样的平台让内容创作与发布更系统化,而不是让手册沦为形式。
Baklib Dagle Tanmer CMS DXP DAM
我们如何定义一位杰出的技术写手?
一位出色的技术写手对他所写作的行业有高水平的了解。他们还具备将极其复杂的主题转化为适合非专业受众的文字的能力。
然而,一位优秀的技术写手同时也是一位高效的技术写手。公司和客户需要知道,他们可以持续信赖这样的人输出一流的写作。而一致性依赖于培养好习惯。在本文中,我们将梳理超级高效技术写手的习惯,看看是什么让他们如此有价值。
💛🧡🧡客户评价:随着时间的推移不断发展,以充分利用技术(例如人工智能),同时还允许自定义字段和设置 - 以满足我们复杂的业务需求

持续提升写作技能

成为一名技术写手是一项具有挑战性的角色——你需要对你选择的主题有透彻的技术知识,但同时你也需要写作技能来有效地书写它。幸运的是,你不需要天生具备某种特殊能力才能成为好写手。像其他所有技能一样,你的写作能力是可以提升的。
那么,怎么做呢?首先,伟大写手的一个习惯是他们读很多书。正如Similarweb企业营销副总裁Yael Klass指出的,阅读对于保持你的写作能力敏锐至关重要。所有类型的内容都可以有益于阅读——至少,能让你尽可能多地接触书面文字。不过,有逻辑地阅读与技术写作相关的内容对提升这些技能极为有益。
例如,书籍仍然是技术写作专家知识的最佳来源之一。有很多值得推荐的书,但Kieran Morgan的Technical Writing Process对于提升技术写手的效率尤其有价值。为什么?因为,正如Josh Fechter在其推荐中解释的,它提供了一个可操作的五步流程,对广泛的技术写手都有价值,并且它面向使用敏捷方法的现代工作场所。
如果你想获取点击即得的资源,Kyle Wilens和Julia Bluff的Tech Writing Handbook完全免费在线。它视觉美观,并提供能帮助你提升写作技能的建议。
除了多读,超级高效的写手还有一件事——他们就是写。根据SAS首席技术写手Michael Harvey的说法,你不需要过度思考——只需养成每天写点什么的习惯。如他解释的,这之所以有效,是因为它让你越来越关注句子的清晰度、段落结构以及提出明确观点——这些正是技术写作必备的技能。
总结一下:高效的技术写手会定期花时间提升写作技能。你可以通过沉浸在书面文字中来做到同样的事——多读相关内容,每天写作。

保持有序

掌控任务是技术写手高效的关键习惯。知道如何管理工作量的写手在同事和客户中评价很高。试想一下,如果写手无法按时产出,高质量的技术写作又有什么意义?
良好组织工作的一部分是确保遵守截止日期。为此,你应该避免规划谬误,这是一种导致你错过截止日期的认知偏差。换句话说,这种现象就是为什么你有时会发现自己几乎在不可能完成的截止日期下工作,从而导致老板和客户不满。解决方法相当简单。根据哈佛商业评论的Kristi DePaul的说法,你应该为超出控制的因素安排缓冲时间。她建议,在原始截止日期上增加25%会使它更现实。
超级高效的技术写手保持有序并遵守截止日期的一个原因是他们通常保持任务清单。清单为写手提供了主要优势。它们减少了将所有事情记在脑中的需要,有助于防止错误和遗漏。有用的清单是什么样的?例如,TimeCamp内容专员Ola Rybacka建议按优先级结构组织:
  • 必须当天完成的项目
  • 必须当天开始的项目
  • 必须当天继续的项目
  • 需要就截止日期、项目问题等联系的客户
除了把待办事项写在纸上,你可以使用像Asana这样的软件工具。Asana对于团队和个人都是很好的工具。其功能之一是可以按各种标准(包括优先级)组织的待办清单。无论你使用像Asana这样的高级工具还是只有一个笔记本,重要的是有某种组织系统,正如自由撰稿人Bart Leahy解释的。在他这里,就是一个颜色编码的Excel电子表格。可以看到,他有产品、客户、日期和备注列,以及不同颜色代表不同任务状态。
高效的技术写手找到保持有序的方法——如果你想成为其中之一,你也应该找到你自己的方法。

专注于高质量研究

那些不熟悉技术写手工作内容的人可能会认为这主要是坐在电脑前写作。然而,高效的技术写手在将想法付诸纸面之前要做很多工作。他们的流程更像John Espirian的图表所示。他认为写作是写手工作流程中的最后一环——没有构成该流程基础部分的阶段,就不可能创建优质文档。而研究是让流程其余部分保持凝聚力的部分。
这需要多少时间?取决于行业和写手。例如,对于下面这位技术写手,可能占据其工作日多达70%。
为了做高质量的研究,最高效的写手不仅仅依赖阅读材料和自行挖掘——尽管那也是找到有价值信息的一种方式。研究的一个重要部分是采访主题专家(SME)。如果你公司里有他们,那会让你的工作更容易。他们不仅能为你提供关于你正在写的主题的宝贵见解,还有关于具体产品或服务的见解。问一位开发者你正在写的产品独特之处在哪里,比花宝贵时间自己琢磨要容易得多。
当你采访SME时,你应该做好相应准备。根据技术写手Kesi Parker的说法,以下是要记住的:
  • 准备相关的问题
  • 使用SME偏好的沟通形式(面对面、邮件、电话等)
  • 如果需要,帮助他们完成任务
无论你如何设置,采访能让你获得其他地方得不到的洞察,正如Yael Klass指出的。在研究上投入时间能区分高效和低效的技术写手。最好的写手知道研究是所有写作的核心,所以保持其强大至关重要。

时不时离开屏幕休息

技术写作是一项有挑战的工作——所有的研究、规划、学习,当然还有写作,都可能让人吃不消。很难相信你能连续工作几个小时而工作质量不下降。休息对于避免精神疲劳以及身体疲劳至关重要。


Baklib,连接企业数字内容的世界! 在数字技术的驱动下,企业未来的发展趋势就是互动、协同、连接。未来拥有什么固然重要,但是更重要的是连接了什么,创新 了什么?赋能了什么? Baklib是一个综合管理的平台,就是在连接企业的所有数字内容。
Baklib Birds
to top icon