主要观点:
- 探讨 AI 代理文档的相关事宜,包括与内部工程文档的区别、是否需分别维护等。
- 介绍内部工程文档为工程团队自用,用于分享知识和标准化贡献。
- 说明 AI 代理通过聊天界面与开发者交互,其能结合 LLM 能力与工具。
- 阐述代理文档可提高代理输出的一致性等,且不同类型的代理有特定的文档查找路径。
- 讨论应保持代理文档和内部工程文档分离还是合并等问题及相关解决方案。
关键信息:
- 内部工程文档如 RFC、指南、教程等,在开源中常称“贡献者文档”。
- AI 代理通过终端命令和工具处理信息并生成总结。
- 代理文档可让代理输出更符合代码库约定等,有项目代理文档、子目录代理文档和用户代理文档等。
- 代理文档的实现方式及相关文件命名约定。
- 保持文档分离的理由如写作风格、内容完整性等,反对的理由如存在重复等。
- 同步、合并、共置、导入、IfThisThenThat 等解决文档分离问题的方案。
重要细节:
- 以具体例子展示 Claude Code 处理文件历史问题及正确构建网站的过程。
- 提及不同代理的文档查找路径,如 Claude Code 的
//CLAUDE.md
等。 - 介绍各种关于文档的参考资料,如分享给团队的视频等。
- 详细说明同步、合并等方案的具体做法,如用 AI 代理同步、完全摒弃某类文档等。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。