开发人员文档：工程师技术写作现场指南

了解软件开发生命周期中每个步骤的文档编制技巧，从了解用户的需求到发布、衡量和维护有用的开发人员文档。

记录良好的项目可以为项目开发人员和软件用户节省时间。没有足够文档的项目会导致开发人员生产力、项目可扩展性、用户采用率和可访问性较差。简而言之：糟糕的文档会扼杀项目。这个新版本已经过全面更新和编辑，考虑到当今开发人员和技术作家的需求，添加了与人工智能、自动化和法学硕士相关的新内容。

开发人员文档揭开了创建优秀开发人员文档的过程的神秘面纱，跟踪软件开发人员团队推出新产品的过程。在此过程中的每一步，您都可以通过示例、模板和原则学习如何创建、衡量和维护文档，这些工具可以适应您自己组织的需求。

您将学会：

• 创建摩擦日志并进行用户研究，以了解用户的挫败感
• 研究、起草和编写不同类型的文档，包括自述文件、API 文档、教程、概念内容和发行说明
• 与定期代码发布一起发布和维护文档
• 通过分析和用户反馈衡量您创建的内容是否成功
• 组织更多的文档，帮助用户在正确的时间找到正确的信息
• 了解何时（以及何时不）将 AI 集成到您的文档工作流程中

本书适合

需要与代码一起创建文档的开发人员，或者技术作家、产品经理、社区经理、开发人员倡导者以及其他创建和贡献文档的技术角色。

‘这本书就像斯特伦克和斯特伦克一样。 White 用于编写技术文档”

—Tom Johnson，Google 高级技术作家

“随着人工智能重塑人们查找和消费信息的方式，了解用户并编写为他们服务的文档至关重要 – 开发人员文档使任何团队都可以访问整个过程。”

—Tal Gluck，GitBook 开发者倡导者和 State of Docs 报告合著者