面向开发人员的文档

Docs for Developers

工程师的技术写作现场指南

概述

  • 使写作技巧与编程技巧保持一致
  • 包含易于遵循的流程、模板和最佳实践,用于创建、组织和维护文档
  • 由来自 Google、Linux 基金会、Stripe、LaunchDarkly 和 Monzo 的经验丰富的作家和开发人员撰写,

 

 关于本书

学习将编程与良好的文档相结合。本书教你软件开发生命周期中每个步骤的文档工艺,从了解用户的需求到发布、衡量和维护有用的开发人员文档。

有据可查的项目为项目的开发人员和软件用户节省了时间。没有足够文档的项目会受到开发人员生产力、项目可扩展性、用户采用率和可访问性较差的影响。简而言之:糟糕的文档会扼杀项目。

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

 学习内容

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

这本书是给谁看的

非常适合需要在代码旁边创建文档的软件开发人员,或者技术编写人员、开发人员倡导者、产品经理和其他为其产品和服务创建和贡献文档的技术角色。

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。