EGM 设置与工作流指南¶
背景¶
Elephant-Goldfish Model (EGM) 是规范驱动开发 (SDD) 的一种实现,基于 Dave Rensin 的开创性文章 Elephants, Goldfish, and the New Golden Age of Software Engineering。
一个普遍建议:在深入工具之前,先从核心哲学开始。将对话序列完整走上一两遍,尤其是当你对 LLM 不熟悉时,这会让你接触到 LLM 的某些怪癖,并培养你使用 LLM 的直觉。
如果你对 EGM 只做一件事,那就是把上述流程做几次,看看你从 LLM 得到的回复是否比以前更好。除了你的时间,它是免费的,不需要安装任何东西,而且说明都按 1 到 N 编号。
如果你喜欢它带来的效果,你会开始注意到一些事情。你不会喜欢总是复制粘贴提示词。你会看到一些重复,并希望 LLM 能自己完成第 1 到第 X 步。EGM 框架就是这种需求的产物。一群实践过它一段时间的人注意到了一些涌现的模式,并试图让入门变得更简单、步骤更少。
运行时设置¶
EGM 技能和角色被打包为适用于 Antigravity、Claude Code、Claude Cowork、OpenAI Codex 和 ChatGPT Work 的插件(安装说明参见运行载体)。
-
技能:
skills/中的技能可以通过插件/扩展清单安装。本指南展示它们的命令时不带前缀(例如/egm-brainstorm、/egm-draft、/egm-review);关于如何在 Antigravity(agy CLI)、Claude Code 和 Codex 中调用它们,例如使用/egm:前缀,参见尝试你的第一个设计。 -
角色:
agents/中的提示词为子代理定义了独立的系统指令。
主工作流¶
虽然 EGM 有一个“主工作流”,但这个流程并非强制规定。这些技能被设计为灵活的。如果符合你的需求,你可以也应该按不同顺序使用它们。
总体目标是拥有:
- 符合你期望的代码
- 解释代码为何如此存在的文档
你可能会发现自己为了解决问题而在各技能之间来回切换,这是值得鼓励的。如果你认为可以一次性完成一个简单的 bug 修复,就不要强行使用“设计优先”的流程。要为当前的工作选用合适的工具。
使用能够解决你当前瓶颈的那项技能。
核心循环¶
“核心”工作流如下所示:
-
/egm-brainstorm:启动一个上游构思会话。该命令会提示开发者澄清概念,然后启动一个多视角的 Goldfish 群来对概念进行压力测试,并生成结构化的concepts_brief.md产物。 -
/egm-draft:起草设计文档。该命令将概念简报或初始想法逐节转换为docs/designs/下正式 Markdown 设计文档。 -
/egm-review:使用 Goldfish 审查设计。在一个全新的、零上下文会话中对设计文档执行多阶段审查,以验证其完整性、清晰度、自包含性和就绪程度。这会有意提供大量反馈。请吸收你认为相关的部分,忽略其余部分。
-
人工审查:将包含你的设计的 Pull Request 发送给另一位人类。EGM 不会取代人工监督,而是鼓励人工监督。人工审查对于确保长期产品一致性和优先级排序至关重要。
-
实施:告诉 AI 按计划构建。如何实施的设计说明应该在你的设计文档中。如果 LLM 犯了小错误,你可以自己修复,或让 LLM 做定点修复。如果结果偏离严重,则更新设计文档并重试。
注意:每个团队在实施阶段都会有不同的相关技能。可读性与风格指南、性能剖析工具、测试策略等等,EGM 在此不做强制要求。将你的技能加入你的实施计划吧!
漂移检测¶
为了确保你的设计规范和当前代码库随时间保持同步,EGM 提供了一项漂移检测技能:
/egm-drift-report:扫描你的设计目录及被引用的代码以发现漂移。任何检测到的偏差都应得到协调——要么更新文档,要么更新代码,由人类决定。
我们建议每周运行一次。如果你有固定的维护轮换安排,将其作为每周例行事项会很有用。
引导现有代码库¶
结构¶
我们建议 EGM 项目目录看起来像这样:
path/to/project
├── _agents/ # (optional, but recommended)
│ └── skills
│ └── <project>_elephant # Custom skill to load project context.
│ └── SKILL.md
└── docs/
└── designs/ # EGM design directory
├── SITEMAP.md # An index of design artifacts
└── FEATURE.md # A detailed design specification
引导¶
/egm-bootstrap <path/to/project> 会自动生成、格式化并对整个目录树中的 README 进行首轮验证,以建立代码库上下文。人类仍应审查此输出。它通过自底向上、递归汇总的过程完成这一工作:
-
叶子目录:对于每个叶子目录,生成一个
README.md,说明该目录的用途并记录每个文件的功能。 -
父目录:递归向上移动目录树,通过总结子目录中的 README 来生成父级
README.md文件。 -
根目录:汇总根级
README.md,以提供系统架构的整体高层视图。
结构化的上下文层级让 Elephants 能够更轻松地导航代码库。EGM 更倾向于由人类掌握这些输出的控制权,这正是该技能存在的原因。如果你所有的设计产物都已经引用了全部代码,那么 README 可能就不是必需的。
项目上下文技能(可选)¶
你可以为你的项目创建一个自定义的 <project>-elephant 技能。这个技能不需要很复杂。它应该告诉 LLM 关于你的项目的信息,并为它提供你认为最相关的上下文链接。仅此而已。
这个技能可以是一种便捷的方式,快速为 LLMs 提供代码路径、文档和重要设计的引用。
随着你的代码库不断增长以及更多设计文档被归档,这个上下文加载器使 Elephant 能够检索相关的架构历史,从而实现更有依据的设计讨论和更精确的功能实现。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 el/elephant-goldfish-model