展开全部

主编推荐语

写文档也可以有趣、省力。应用领域驱动设计,让代码与文档相辅相成。

内容简介

这是一本活文档参考指南,教你如何像写代码一样有趣地持续维护文档。

书中系统地阐述了计算机软件开发各个阶段中文档写作的步骤、内容、方法、工具、特点和要求,详尽指导软件开发人员和文档开发工程师写出规范的文档,包括软件文档的概念和内容,软件文档编写的原则和步骤,软件文档的管理和维护,可行性研究报告、软件需求报告、软件测试计划等文档的写作方法和写作技巧。

目录

  • 版权信息
  • 献词
  • 推荐序
  • 推荐语
  • 前言
  • 本书主题
  • 目标读者
  • 阅读建议
  • 本书内容
  • 致谢
  • 第1章 重新思考文档
  • 1.1 一则来自活文档世界的故事
  • 1.2 传统文档存在的问题
  • 1.3 文档编写的是知识
  • 1.4 文档是为了传递知识
  • 1.5 活文档的核心原则
  • 1.6 大部分知识是已经存在的
  • 1.7 固有文档
  • 1.8 专门知识与通用知识
  • 1.9 确保文档准确
  • 1.10 挑战文档的大问题
  • 1.11 让活动变得有趣
  • 1.12 文档重启
  • 1.13 DDD入门
  • 1.14 小结
  • 第2章 BDD:活需求说明的示例
  • 2.1 BDD是为了对话
  • 2.2 实现自动化的BDD是为了活文档
  • 2.3 在文件中解析场景
  • 2.4 功能文件示例
  • 2.5 用典型案例展示活文档的方方面面
  • 2.6 更进一步:充分利用活文档
  • 2.7 小结
  • 第3章 知识开发
  • 3.1 识别权威性知识
  • 3.2 知识现在在哪里
  • 3.3 单一来源发布
  • 3.4 设置一致性机制
  • 3.5 整合分散的信息
  • 3.6 现成的文档
  • 3.7 工具历史
  • 3.8 小结
  • 第4章 知识增强
  • 4.1 当编程语言不够用时
  • 4.2 使用注解编写文档
  • 4.3 按照约定编写文档
  • 4.4 外部文档编写方法
  • 4.5 设计自定义注解
  • 4.6 处理全模块知识
  • 4.7 固有知识增强
  • 4.8 机器可访问的文档
  • 4.9 记录你的决策依据
  • 4.10 确认你的影响力(又名项目参考文献)
  • 4.11 将提交消息作为全面的文档
  • 4.12 小结
  • 第5章 活知识管理:识别权威性知识
  • 5.1 动态的知识管理
  • 5.2 突出核心
  • 5.3 突出启发性的范例
  • 5.4 导览和观光地图
  • 5.5 总结:策展人筹备一场艺术展览
  • 5.6 小结
  • 第6章 自动化文档
  • 6.1 活文档
  • 6.2 活词汇表
  • 6.3 活图表
  • 6.4 小结
  • 第7章 运行时文档
  • 7.1 示例:活服务图表
  • 7.2 可见测试
  • 7.3 示例:使用事件溯源时的可见测试
  • 7.4 内省的工作方式:内存中的代码即知识来源
  • 7.5 小结
  • 第8章 可重构文档
  • 8.1 代码即文档
  • 8.2 命名作为最初的文档
  • 8.3 类型驱动文档
  • 8.4 组合方法
  • 8.5 连贯风格
  • 8.6 案例研究:由注释引导的重构代码示例
  • 8.7 集成的文档
  • 8.8 使用纯文本图表
  • 8.9 小结
  • 第9章 稳定文档
  • 9.1 常青内容
  • 9.2 关于常青文档的提示
  • 9.3 链接的知识
  • 9.4 稳定知识的类别
  • 9.5 愿景声明
  • 9.6 投资稳定知识
  • 9.7 小结
  • 第10章 避免传统文档
  • 10.1 关于正式文档的对话
  • 10.2 协同工作,实现持续的知识共享
  • 10.3 在咖啡机旁沟通
  • 10.4 想法沉淀
  • 10.5 一次性文档
  • 10.6 按需文档
  • 10.7 互动式文档
  • 10.8 声明式自动化
  • 10.9 强制性规范
  • 10.10 受限行为
  • 10.11 避免编写文档的设计原则
  • 10.12 示例:零文档游戏
  • 10.13 小结
  • 第11章 超越文档:活设计
  • 11.1 倾听文档
  • 11.2 谨慎决策
  • 11.3 丢脸的文档
  • 11.4 文档驱动开发
  • 11.5 滥用活文档(反模式)
  • 11.6 活文档拖延症
  • 11.7 可降解的文档
  • 11.8 干净透明
  • 11.9 无处不在的设计技巧
  • 11.10 记者Porter采访Living Doc Doc先生
  • 11.11 小结
  • 第12章 活架构文档
  • 12.1 记录问题
  • 12.2 明确的质量属性
  • 12.3 决策日志
  • 12.4 分形架构文档
  • 12.5 架构全景图
  • 12.6 架构规范
  • 12.7 透明的架构
  • 12.8 架构实现检查
  • 12.9 测试驱动架构
  • 12.10 小规模模拟即活架构文档
  • 12.11 系统隐喻
  • 12.12 小结
  • 第13章 在新环境中引入活文档
  • 13.1 秘密实验
  • 13.2 新事物必须能用而且必须被接受
  • 13.3 案例研究:向团队成员介绍活文档的故事
  • 13.4 针对活文档的普遍反对意见
  • 13.5 将遗留文档迁移到活文档中
  • 13.6 边际文档
  • 13.7 案例研究:在批处理系统中引入活文档
  • 13.8 向管理层推销活文档
  • 13.9 在精神实质上合规
  • 13.10 小结
  • 第14章 为遗留应用程序编写文档
  • 14.1 文档破产
  • 14.2 遗留应用程序就是知识化石
  • 14.3 气泡上下文
  • 14.4 叠加结构
  • 14.5 突出结构
  • 14.6 外部注解
  • 14.7 可降解的转化
  • 14.8 商定标语
  • 14.9 强制执行的遗留规则
  • 14.10 小结
  • 补充知识:显而易见的文档
  • A.1 关注差异
  • A.2 只描述受众不知道的信息
  • A.3 易于搜索的文档
  • A.4 就现在,一起创建具体示例吧
  • A.5 Stack Overflow文档
  • A.6 用得起,也吸引人
  • A.7 非正规的媒介
  • A.8 小结
  • 活文档模式图表
  • B.1 活文档模式语言
  • B.2 活文档要素
  • B.3 知识增强
  • B.4 避免传统文档
  • B.5 超越文档
  • 作者简介
展开全部

评分及书评

3.9
8个评分
  • 用户头像
    给这本书评了
    5.0
    文档仙术机器

    重新看待我的电脑。却还待加载入仙法招式

      转发
      评论
      用户头像
      给这本书评了
      5.0

      本书提及的可视化活文档的实践更是给我们打开了一扇崭新的窗户。不是死板的代码逆向工程,而是通过运用诸如 Graphviz 这样的工具,形成活图表来清晰、直观地呈现软件系统的设计质量与编码质量,如通过代码自动生成六边形架构图、上下文映射图和业务领域概览图等。这些活图表实际上就是活架构文档的重要组成部分。

        转发
        评论
        用户头像
        给这本书评了
        3.0

        挺难执行

          转发
          评论
        • 查看全部5条书评

        出版方

        人民邮电出版社

        人民邮电出版社是工业和信息化部主管的大型专业出版社,成立于1953年10月1日。人民邮电出版社坚持“立足信息产业、面向现代社会、传播科学知识、服务科教兴国”,致力于通信、计算机、电子技术、教材、少儿、经管、摄影、集邮、旅游、心理学等领域的专业图书出版。