知识卡片
文档成为共同知识入口
服务文档既要保存信息,也要帮助团队形成正确的共同认识。集中、可搜索的入口让其他团队无需反复反向阅读代码,就能了解服务职责、依赖和运行方式。原书批评仅靠README与注释,核心是可访问性和内容完整;文件格式本身并不能判定是否具有合格文档。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 文档化和理解 · 查看原书依据
生产就绪的微服务文档是集中式的微服务知识库。知识的分享包含两方面内容:一方面是关于微服务的信息,一方面是组织对微服务的理解。糟糕的文档所带来的问题可以被分为两个子问题:文档的缺乏和理解的缺乏。要解决这两个子问题,需要对微服务进行标准的文档化,并把它们放在合适的地方,方便人们了解微服务。
参考来源
- 位置:《生产微服务》文档化和理解(来源项目:a19c7933-4eda-4176-aebd-30fe7e1ad292;源文件:extracted/生产微服务/_epub-src/OEBPS/text00011.html)
- 结论依据:术语含义与相关正文合读,区分定义、目的及其实际适用边界,不把示例比例或工具选择当作普遍定律。
- 原始内容:生产就绪的微服务文档是集中式的微服务知识库。知识的分享包含两方面内容:一方面是关于微服务的信息,一方面是组织对微服务的理解。糟糕的文档所带来的问题可以被分为两个子问题:文档的缺乏和理解的缺乏。要解决这两个子问题,需要对微服务进行标准的文档化,并把它们放在合适的地方,方便人们了解微服务。