技术写作者必读的14本技术写作书籍
浏览:1
巴克励步
我最近在梳理产品手册时,发现团队里很多新人总在结构化和交付上卡壳。其实技术写作这件事,底层逻辑是相通的——清晰、准确、可复用。Baklib的产品手册建设模块正是基于这些原则设计的,但工具再好,基本功也得扎实。今天推荐的14本书,从入门到项目管理,覆盖了技术写作的全链路,适合每个想提升文档质量的人。 Handbook of Technical Writing 作者:Michelle Carey, Mo
我最近在梳理产品手册时,发现团队里很多新人总在结构化和交付上卡壳。其实技术写作这件事,底层逻辑是相通的——清晰、准确、可复用。Baklib的产品手册建设模块正是基于这些原则设计的,但工具再好,基本功也得扎实。今天推荐的14本书,从入门到项目管理,覆盖了技术写作的全链路,适合每个想提升文档质量的人。
Handbook of Technical Writing
作者:Michelle Carey, Moira McFadden Lanyi, Deirdre Longo, Eric Radzinski, Shannon Rouiller, Elizabeth Wilde
出版:第十二版(2020年6月15日),Bedford/St. Martin's
页数:640页
💛🧡🧡客户评价:当从旧的 Web 系统转移到无头 CMS 时,我们希望通过快速的响应时间提高我们的上线速度,以便我们可以与我们决定的任何 Web 堆栈以及我们将来想要迁移到的任何 Web 堆栈一起使用。
适用:技术写作风格与用法的全面参考
这是目前最全面的技术写作资源之一。它探讨了从求职、职业概览到技术写作用的技术和工具等数百个主题。第十二版内容依然新鲜,对各类主题的处理也是最新的。指南还提供了近100个示例文档,并按字母顺序组织,可作为快速参考手册。
The Essentials of Technical Communication
作者:Elizabeth Tebeaux, Sam Dragga
出版:第五版(2020年11月6日),Oxford University Press
页数:448页
适用:学习清晰传达技术信息
这本教科书通过提供大量案例研究、场景和示例文档,教授职场中清晰沟通的基本原则。这些原则随后应用于办公室的所有沟通形式,包括电子邮件、备忘录、报告,以及最重要的网站和说明书。书中还提供了实践活动,帮助读者自测知识和新技能。
Technical Writing Process
作者:Kieran Morgan
出版:2015年3月4日,Better On Paper Publications
页数:260页
适用:让技术写作更有条理
Kieran Morgan的简单五步法指南是让写作过程可重复、更高效的绝佳起点。指南涵盖了多种技术文档类型,如手册、用户指南和流程。Morgan使用简洁的语言和大量示例场景来解释技术写作的复杂性,让即使还未写过第一份文档的读者也能轻松理解。
The Insider's Guide to Technical Writing
作者:Krista Van Laan
出版:2012年5月1日,XML Press
页数:346页
适用:考虑从事技术写作职业的人
技术写作是任何有写作天赋且对技术有特殊兴趣的人的绝佳职业选择。这本技术写作领域的全面概览,为读者提供了在该行业取得成功所需的技能知识,以及从第一天开始就脱颖而出的步骤。书中还充满了应对技术写作工作压力和回报的有用提示,是考虑进入这个动态领域的人的完美选择。
Managing Your Documentation Projects
作者:JoAnn T. Hackos
出版:1994年4月6日,Wiley
页数:656页
适用:学习文档项目管理的原则
这不是一本新书,但其中的教训是常青的。JoAnn T. Hackos是一位资深项目经理,曾为IBM和惠普等公司提供文档项目管理咨询。Hackos是计划大师,她的书教会读者如此细致地规划文档,以至于初稿几乎可以自动生成。技术写作不全是创意,因此她的方法论绝对值得反复研读。
Technical Communication
作者:Mike Markel
出版:Bedford/St. Martin's
页数:832页
适用:从更广泛的角度学习技术写作
这本教材至今仍在许多大学的技术写作、沟通和文档课程中使用,提供了对各类技术沟通最全面的指南之一。其独特之处在于实践性的方法。作者提供了在职业和个人生活中都会遇到的写作场景的策略,以及各类写作的示例文档。最新版本可在网上找到。
Technical Writing For Dummies
作者:Sheryl Lindsell-Roberts
出版:2001年3月13日,For Dummies
页数:336页
适用:技术写作初学者概览
像大多数For Dummies系列书籍一样,这本书是想要鸟瞰技术写作就业市场、创建技术文档过程以及属于此类别各种文档的绝佳选择。Sheryl Lindsell-Roberts强调技术文档需要具有吸引力才能真正帮助用户实现目标,并提供了大量关于如何避免撰写乏味、令人困惑文档的建议,这是每个技术写作者都应掌握的技能。
Managing Writers: A Real World Guide To Managing Technical Documentation
作者:Richard L. Hamilton
出版:2008年12月31日,XML Press
页数:282页
适用:管理文档项目和人
另一本面向文档项目经理的指南,这次更关注文档中的人的因素。换句话说,这是技术写作者和领导技术写作团队的管理者的绝佳资源。这本书的价值在于它提供了现实世界的视角,不粉饰文档工作中的起起落落。对于任何考虑从事这一领域的人来说,这本书会引发思考,帮助你决定这是否适合你。
The Elements of Technical Writing
作者:Gary Blake, Robert W. Bly
出版:1993年8月1日,Pearson P T R
页数:174页
适用:技术写作快速参考
任何技术写作者案头必备。开篇部分充满了清晰、简洁、准确写作的可操作技巧,包括避免术语和正确连字符等常见规则。每条规则都附有解释和示例。书的另一部分专门介绍技术文档类型及其写作最佳实践。部分信息可能有些过时,但通用原则仍然适用于现代技术写作。
Is the Help Helpful?
作者:Jean Hollis Weber
出版:2004年11月28日,Hentzenwerke Publishing
页数:224页
适用:为客服编写文档
前面介绍了一些更宏观的资源,现在这本更专业。Jean Hollis Weber专门撰写了关于为客服和其他类型的在线帮助编写文档的书籍。这本书探讨了帮助指南经常出错的地方,并确立了一些原则,用于编写对典型互联网用户真正有效的帮助文档。书中还包含了关于原型设计和可用性测试的优秀章节,帮助写作者建立每次都能奏效的写作流程。
Technical Writing Basics: A Guide to Style and Form
作者:Brian R. Holloway
出版:第二版(2001年6月1日),Pearson College Div
页数:210页
适用:以更具信息性和说服力的风格写作
这本简明的指南强调了在技术写作中清晰度和读者导向的重要性。Holloway提供了针对各种文档类型(从报告到操作指南)的具体策略,并包含大量示例说明如何将原则付诸实践。对于希望提升文档说服力和信息传递效率的写作者来说,这是一本实用的参考书。