面向开发者的文档
Docs for Developers
Jared Bhatti, Heidi Waterhouse · 初版 2021 年
- 10次提及
- 4人推荐
- 7位 HN 评论者
简介
学习将写作艺术与编程工艺融为一体。本书将教你如何在软件开发生命周期的每个阶段创建文档，从理解用户需求到发布、评估以及维护高价值的开发者文档。结构良好的文档项目既能为项目开发者节省时间，又能为软件用户提供便利；反之，缺乏充分文档的项目则会面临开发效率低下、扩展受阻、用户采用率低以及易用性差等问题。简而言之：糟糕的文档会毁掉项目。Docs for Developers 揭开了
Hacker News 读者推荐
……感谢 debanjan16 提了一个非常棒的问题，让我的“待读清单”里新增了好多高质量的书籍！奇怪的是，对于我自己的老本行技术写作（technical writing），脑子里却一片空白。《面向开发者的文档指南》（Docs for Developers）在全面覆盖高质量文档流程的基础知识方面做得非常出色。但总觉得应该还有哪本书，曾启发过我更深入地思考如何进行有效沟通……
kaycebasques 在 HN 的推荐
关于写文档，推荐看看 Bhatti 等人写的《面向开发者的文档指南》（Docs for Developers）。副标题称这本书是“写给工程师的技术写作实战指南”，名副其实。它一步一步地详细为你概述了什么是高质量……
kaycebasques 在 HN 的推荐
请看看 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…
teleforce 在 HN 的推荐
找书
豆瓣 微信读书 京东 Open Library ISBN 9781484272176
数据整理自 Hacker News 公开评论，数据来源 hackerbooks.org 与 Open Library。