mcpField
B
brain-to-docs

brain-to-docs

github.com/davidondrej文档处理4.2k217 次安装今天更新
代码仓库

关于 brain-to-docs

brain-to-docs 是一项技能,用简洁的 Markdown 文档记录用户的决策、偏好和项目愿景。它会先读取现有文档,并在每次回答后更新 README 或以 ADR 记录决策。

主要功能

  1. 01优先读取 README 和 ADR
  2. 02默认提出五个不同角度的纯文本问题
  3. 03每次回答后更新文档
  4. 04将愿景与决策分别记录
  5. 05按规定章节编写编号 ADR

适用场景

  1. 01在项目 README 中记录产品愿景
  2. 02通过 ADR 记录项目决策
  3. 03将持续讨论整理为维护中的文档

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/davidondrej/skills --skill brain-to-docs

安装后在 Claude Code 中输入/brain-to-docs确认已加载。

详细介绍

brain-to-docs

唯一目标:尽可能多地将用户的品味、判断、知识、愿景、偏好和决策提取为文本,保存为项目清晰、简洁的 Markdown 文档。README 保存愿景;docs/adr/ 保存决策。

工作循环

  1. 每次都先检查文档。 开始任何操作前,先阅读 docs/adr/(以及 README.md)——其他 Agent 和人员会不断添加或编辑 ADR。
  2. 用纯文本提出 5 个不同的问题(绝不使用问题 UI)——默认提 5 个,除非用户要求其他数量。问题要多样化:从宽广、有创意的角度提出独特的问题,而不是都属于同一类型(例如,不能全是“技术栈”或“产品”或“变现”相关)。例外:如果用户指定了某个关注领域,就按其要求提问。用户可以回答他们认为最有用的问题。
  3. 每次回答后都更新文档——没有例外。由你决定更新 README.md 还是新建 ADR,选择合适的方式即可。
  4. 重复以上步骤,直到用户说“我们结束了”(或类似的话)。

规则

  • 在这场“从想法到文档”的过程中,所有回答都必须非常简洁,句子要短,并且全部使用通俗易懂的英文。
  • ADR:使用简短的编号文件名 NNNN-slug.md,包含 Status、Context、Decision 和 Consequences。
  • README:只写愿景。决策写入 ADR。
  • 除非用户要求,或他们正在犯严重错误,否则不要质疑用户的想法。

评论

支持 Markdown