跳到主要内容
SpringerLink公司
登录
围裙

开发人员文档

工程师技术写作现场指南

  • 书
  • ©2021

概述

作者：
  1. 贾里德·巴蒂

    1. 美国伯克利

    查看作者出版物

    您还可以在中搜索此作者 公共医学   谷歌学者

  2. 莎拉·科尔利森

    1. 加拿大维多利亚州

    查看作者出版物

    您还可以在中搜索此作者 公共医学   谷歌学者

  3. 詹·兰伯恩

    1. 英国康沃尔

    查看作者出版物

    您还可以在中搜索此作者 公共医学   谷歌学者

  4. 大卫·努涅斯

    1. 美国旧金山

    查看作者出版物

    您还可以在中搜索此作者 公共医学   谷歌学者

  5. 海蒂水屋

    1. 美国Mounds View

    查看作者出版物

    您还可以在中搜索此作者 公共医学   谷歌学者

  • 将写作技巧与编程技巧结合起来
  • 包含用于创建、组织和维护文档的易于遵循的流程、模板和最佳实践
  • 由来自谷歌、Linux基金会、Stripe、LaunchDarkly和Monzo的经验丰富的作家和开发人员编写，

这是订阅内容的预览，通过机构登录 以检查访问。

访问本书

通过机构登录

订阅并保存

施普林格+基础
32.70欧元/月
  • 每月购买10件
  • 下载文章/章节或电子书
  • 1单位=1条或1章
  • 随时取消
立即订阅

立即购买

电子书 46.99欧元
价格包括增值税（中国）
  • 以EPUB和PDF格式提供
  • 在任何设备上读取
  • 即时下载
  • 永远拥有它
软封面书籍 54.99欧元
价格不含增值税（中国）
  • 紧凑、轻量级版本
  • 3至5个工作日内发货
  • 全球免费送货-查看信息

税务计算将在结账时完成

其他访问方式

为您的图书馆授权本电子书

机构认购

关于这本书

学习将编程与良好的文档集成。这本书教你软件开发生命周期中每个步骤的文档编制技巧，从了解用户的需求到发布、度量和维护有用的开发人员文档。

有良好文档记录的项目为项目开发人员和软件用户节省了时间。没有足够文档的项目会导致开发人员生产力、项目可伸缩性、用户采用率和可访问性较差。简而言之：糟糕的文档会扼杀项目。 

开发人员文档对创建优秀开发人员文档的过程进行解密，跟踪软件开发人员团队开发新产品的过程。在这一过程中的每一步，您都可以通过示例、模板和原则学习如何创建、度量和维护文档，这些工具可以适应您自己组织的需要。

你将学到什么

  • 创建摩擦日志并进行用户研究，以了解用户的沮丧情绪
  • 研究、起草和编写各种文档，包括README、API文档、教程、概念内容和发行说明
  • 发布和维护文档以及常规代码发布
  • 通过分析和用户反馈来衡量您创建的内容是否成功
  • 组织更大的文档集，帮助用户在正确的时间找到正确的信息

这本书的读者

非常适合于需要与代码一起创建文档的软件开发人员，或者适合于为其产品和服务创建文档并为其做出贡献的技术作者、开发人员拥护者、产品经理和其他技术角色。

 


其他人正在查看的类似内容

关键词

目录（11章）

  1. 前部物质

    第i-xxv页
    下载章节PDF格式

  2. 了解你的观众

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第1-21页

  3. 规划您的文档

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第23-44页

  4. 起草文件

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第45-66页

  5. 编辑文档

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第67-81页

  6. 集成代码示例

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第83-99页

  7. 添加视觉内容

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第101-120页

  8. 发布文档

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第121-131页

  9. 收集和整合反馈

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第133-146页

  10. 衡量文档质量

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第147-167页

  11. 组织文档

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第169-185页

  12. 维护和弃用文档

    • 贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）
    第187-200页

  13. 背景资料

    第201-225页
    下载章节PDF格式
返回页首

作者和附属机构

  • 美国伯克利

    贾里德·巴蒂

  • 加拿大维多利亚州

    莎拉·科尔利森

  • 英国康沃尔

    珍·兰伯恩

  • 美国旧金山

    大卫·努内斯

  • 美国Mounds View

    海蒂水屋

关于作者

贾里德·巴蒂



Jared是Alphabet公司的技术撰稿人，也是谷歌云文档团队的联合创始人。过去14年，他一直在Alphabet记录一系列项目，包括Kubernetes、App Engine、Adsense、谷歌数据中心以及谷歌的环境可持续性努力。他目前负责Waymo的技术文档，并指导该行业的几位初级作家。


莎拉·科尔利森


Sarah（她/她，他们/他们）以Linux基金会首席技术作者的身份开始了这本书，并以Stripe的第一位员工技术作家的身份结束了它。2017年至2021年，Sarah担任Kubernetes文档的联合主席，此前曾在GitHub、Rackspace和多家初创公司从事开发人员文档的工作。他们喜欢在会议上发言，喜欢指导各种能力和背景的作家和演讲者。

海蒂水屋


Heidi在微软、戴尔软件和许多初创公司工作了几十年，学习与开发人员沟通，学习为开发人员服务。她目前是LaunchDarkly的主要开发人员倡导者，但她感到放心的是，技术交流在所有角色中都是通用的。 

大卫·努内斯

David在Stripe领导技术写作组织，在那里他创建了内部文档团队，并为Increment杂志撰稿。在Stripe之前，他在优步创建并领导技术写作组织，并在Salesforce担任文档领导职务。他领导的团队撰写了关于云、本土基础设施、自动驾驶卡车和经济基础设施的文章，他研究了技术文档可以塑造用户体验的多种方式。David还在知识平台领域担任多家初创公司的顾问。


詹·兰伯恩


Jen领导Monzo Bank的技术写作和知识管理学科。在进军金融科技之前，她作为政府数字服务（GDS）的技术写作主管领导了英国政府的一个纪录片社群。从政府部门转到金融部门后，她意识到自己被吸引到在传统上不友好的行业中创建包容性和以用户为中心的内容。她喜欢使用开发人员工具来管理文档，为工程师揭开写作过程的神秘面纱，指导初级作家，并在会议上展示她在文档方面的冒险经历。



书目信息

  • 书籍标题:开发人员文档

  • 书籍副标题:工程师技术写作现场指南

  • 作者:贾里德·巴蒂（Jared Bhatti）、莎拉·科尔莱森（Sarah Corleissen）、延·兰博恩（Jen Lambourne）、大卫·努内斯（David Nunez）、海蒂·沃特豪斯（Heidi Waterhouse）

  • 内政部:https://doi.org/10.1007/978-1-4842-7217-6

  • 出版商:加利福尼亚州阿普里斯·伯克利

  • 电子书包: 专业和应用计算,Apress访问簿,专业与应用计算（R0）

  • 版权信息:Jared Bhatti、Sarah Corleissen、Jen Lambourne、David Nunez、Heidi Waterhouse 2021年

  • 软封面ISBN:978-1-4842-7216-9发布日期：2021年10月1日

  • 电子书ISBN:978-1-4842-7217-6发布日期：2021年9月30日

  • 版本号:1

  • 页数:二十五、 225个

  • 插图数量:31个b/w插图

  • 话题: Web开发, 开放源代码

与我们一起发布

政策和道德

返回页首

搜索

导航