面向开发者的文档
Docs for Developers
Jared Bhatti、Heidi Waterhouse · 初版 2021 年
4人推荐
7位读者提及
10次提及
学习将写作艺术与编程工艺融为一体。本书将教你如何在软件开发生命周期的每个阶段创建文档，从理解用户需求到发布、评估以及维护高价值的开发者文档。结构良好的文档项目既能为项目开发者节省时间，又能为软件用户提供便利；反之，缺乏充分文档的项目则会面临开发效率低下、扩展受阻、用户采用率低以及易用性差等问题。简而言之：糟糕的文档会毁掉项目。Docs for Developers 揭开了
Hacker News 上怎么说
正在加载完整评论……
……感谢 debanjan16 提了一个非常棒的问题，让我的“待读清单”里新增了好多高质量的书籍！奇怪的是，对于我自己的老本行技术写作（technical writing），脑子里却一片空白。《面向开发者的文档指南》（Docs for Developers）在全面覆盖高质量文档流程的基础知识方面做得非常出色。但总觉得应该还有哪本书，曾启发过我更深入地思考如何进行有效沟通……
…debanjan16 for constructing a well-formulated question that delivered lots of high-quality additions to my "to read" list! Strangely enough nothing is coming to mind for my field, technical writing. Docs for Developers is great at covering the end-to-end basics of a high-quality documentation process. But I feel like there is some book out there that has inspired me to think more deeply about how to effectively communicate…
关于写文档，推荐看看 Bhatti 等人写的《面向开发者的文档指南》（Docs for Developers）。副标题称这本书是“写给工程师的技术写作实战指南”，名副其实。它一步一步地详细为你概述了什么是高质量……
Regarding documentation, check out Docs for Developers by Bhatti et al. The subtitle describes the book as "an engineer's field guide to technical writing" and that's exactly what the book is. It provides you a detailed step-by-step overview of what high-quality…
请看看 Springer 出版的这两本关于技术写作的书。1) 《面向开发者的文档指南：写给工程师的技术写作实战指南》（Docs for Developers: An Engineer’s Field Guide to Technical Writing）https://link.springer.com/book/10.1007/978-1-4842-7217-6 2) 《系统工程需求编写指南》（Requirements Writing for System Engineering）：https://link.springer.com/book/10.1007/978-1-4842-2099-3…
Please check these two books on technical writing from Springer. 1) Docs for Developers: An Engineer’s Field Guide to Technical Writing https://link.springer.com/book/10.1007/978-1-4842-7217-6 2) Requirements Writing for System Engineering: https://link.springer.com/book/10.1007/978-1-4842-2099-3…
……清晰沟通的基石。在打牢这些基础之后，你还需要了解技术文档工程师（technical writer）所遵循的流程，以此搞清楚客户真正需要什么样的文档。《面向开发者的文档指南》（Docs For Developers）[3] 相当扎实地梳理了许多技术写作人员遵循的工作流程。[1] https://developers.google.com/tech-writing/one [2] https://www.amazon.com/Writers-Reference-Diana-Hacker/dp/131... [3] https://www.amazon.com/Docs-Developers-Engineers-Technical-W...
…the foundation of communicating clearly. After you've got those fundamentals down, you'll want to learn about the processes that technical writers follow to figure out what docs customers really need. Docs For Developers [3] is a pretty solid overview of the process that many TWs follow. [1] https://developers.google.com/tech-writing/one [2] https://www.amazon.com/Writers-Reference-Diana-Hacker/dp/131... [3] https://www.amazon.com/Docs-Developers-Engineers-Technical-W...
……我的本职工作，我一直在想买几本技术写作方面的纸质书，好在工作日随时翻阅。当然，也是为了在 Zoom 开会时镇住我的对手们。目前我的首选是《面向开发者的文档指南》（Docs for Developers）和经典的《文风的要素》（Elements of Style），两本书相辅相成，分别涵盖了最新潮的文档策略和最经典的非虚构写作技巧。我真的很想开始……
…my job, and I've been looking to buy some hard copies of technical writing books so I can refer to them easily during the workday. And to intimidate my enemies on Zoom, of course. So far my go-tos are "Docs for Developers" and the classic "Elements of Style", which complement each other well, covering the newest documentation strategies and the oldest nonfiction writing strategies, respectively. I'd really like to start…
来看看这本针对开发者的技术写作新书。《面向开发者的文档指南：写给工程师的技术写作实战指南》（Docs for Developers: An Engineer’s Field Guide to Technical Writing）https://link.springer.com/book/10.1007/978-1-4842-7217-6
Check this new book on technical writing for developers. Docs for Developers: An Engineer’s Field Guide to Technical Writing https://link.springer.com/book/10.1007/978-1-4842-7217-6