更新时间:2021-05-18 16:36:27
封面
版权信息
献词
推荐序
推荐语
前言
本书主题
目标读者
阅读建议
本书内容
致谢
第 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 互动式文档