Compound docs
记录团队已解决问题,方便复用
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:Compound docs。 它的用途是:记录团队已解决问题,方便复用 完整的 Skill 内容见:https://321skill.com/skills/compound-docs-x-5/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'记录我们解决的内存泄漏问题,原因是未关闭的数据库连接,修复方式是在每次查询后显式调用 connection.close(),涉及文件 db.js,已提交 PR #123。' 它会自动将这个问题格式化为标准条目,包含标题、根因、解决方案、关联代码和提交记录,并存入 Compound docs 知识库,方便团队后续检索。
介绍
Compound docs 是一个专注于捕获和归档团队已解决问题(solved problems)的工具。在日常开发、运维或项目推进中,经常会遇到重复出现的 Bug、配置坑、业务逻辑难点等,每次解决后若没有系统记录,下次遇到类似问题仍需重新排查。该工具帮助团队将每次的解决方案结构化存储,并按照问题类型、场景、解决方案步骤等维度组织,从而形成可检索的知识库,减少重复劳动,提升团队效率。
使用方式非常简单:当团队解决了一个问题后,通过命令行或 API 将问题描述、根因分析、解决步骤、关键代码片段等输入到 Compound docs 中。工具会自动解析并生成结构化的文档条目,支持标签、全文搜索、版本追溯等功能。你可以通过 CLI 快速查询,或在团队协作平台(如 Slack、飞书)中集成 bot 进行检索。
适合需要频繁处理重复问题的技术团队,特别是后端开发、运维工程师、文档工程师和项目经理。对于跨团队协作、需要快速 onboarding 新人的场景尤为有效,因为新人可以快速检索到历史问题记录,避免走弯路。也适合个人开发者记录自己的踩坑日志,形成个人知识库。
建议团队在每次解决完问题后立即记录,并标注问题等级(如紧急、常见、罕见)。注意不要记录过于敏感的信息(如密码、密钥),工具本身不提供自动脱敏功能,需人工审查。另外,该工具定位为“已解决问题存档”,不适合用于实时协作编辑或复杂项目管理,建议配合其他项目管理工具(如 Jira、Notion)使用。
核心特点
不同于通用笔记或文档工具,Compound docs 专门以“问题-解决方案”为最小单元,自动提取结构化字段(根因、步骤、代码等),并支持按问题类型和场景的精准检索,而非简单的全文搜索。
注意事项
不适合实时协作编辑或作为项目管理工具,且不支持自动脱敏敏感信息,需人工审核。
常见问题
如何安装 Compound docs?
可以通过 npm 全局安装:npm install -g compound-docs,或使用 npx 直接运行:npx compound-docs。
能否导入现有的文档或 Notion 笔记?
目前支持导入 Markdown 格式的文档,你可以将现有笔记导出为 Markdown 后批量导入,工具会自动识别并结构化存储。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/compound-docs-x-5/raw/index.md 读取 Compound docs 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/compound-docs-x-5/raw/index.md(查看排版版本)