yuxuanhui
91861565bb
- Introduced API guidelines for interface contracts and request handling. - Added design tokens usage guidelines for consistent styling across the project. - Established DTO guidelines for defining request parameters and response data types. - Created frontend structure guidelines to clarify directory organization and code placement rules. - Compiled a comprehensive frontend development guideline document covering various aspects of the development process. - Implemented quality guidelines to ensure code maintainability and adherence to best practices.
94 lines
5.5 KiB
Markdown
94 lines
5.5 KiB
Markdown
# AI Coding 复利大脑
|
|
|
|
这里是跨项目 AI coding 经验的统一来源，用于捕获、验证、检索、提升和审计可复用经验。
|
|
|
|
## 工作流
|
|
|
|
```text
|
|
项目任务
|
|
→ inbox 候选经验
|
|
→ learnings 已验证经验
|
|
→ patterns 跨项目模式
|
|
→ assets 可执行资产
|
|
→ 项目 AGENTS / 测试 / hooks / skills
|
|
```
|
|
|
|
## 导航
|
|
|
|
- [[inbox/index|Inbox]]：尚未验证的候选经验
|
|
- [[learnings/index|Learnings]]：有证据支持的经验
|
|
- [[patterns/index|Patterns]]：跨项目验证的通用模式
|
|
- [[projects/index|Projects]]：项目索引和同步状态
|
|
- [[experiments/index|Experiments]]：模型、提示词和工作流实验
|
|
- [[assets/index|Assets]]：可以下发的规则、Skill、hook 和 eval
|
|
- [[maintenance/index|Maintenance]]：冲突、过期和待提升内容
|
|
|
|
## 经验 Meta 字段
|
|
|
|
每份经验的 YAML frontmatter 使用以下 12 个字段。除特别说明外，字段都应填写；当前 `brain.py validate` 会强制校验前 10 个标量字段，`projects` 和 `tags` 由 schema 约定为必填列表，但暂未被校验脚本强制检查。
|
|
|
|
| 字段 | 含义 | 格式或枚举值 |
|
|
|---|---|---|
|
|
| `id` | 经验的稳定唯一标识，也用于文件名和检索。 | `YYYYMMDD-short-slug`；日期后接小写字母、数字或连字符，例如 `20260724-bounded-list-flex-height-chain`。 |
|
|
| `title` | 清晰、可搜索的经验标题，应概括触发场景和核心做法。 | 自由文本，无固定枚举。 |
|
|
| `created` | 首次创建该经验的日期。 | `YYYY-MM-DD`。 |
|
|
| `updated` | 最近一次实质更新该经验内容或元信息的日期。 | `YYYY-MM-DD`。 |
|
|
| `status` | 经验在验证与提升生命周期中的状态。 | `candidate`、`validated`、`promoted`、`stale`、`superseded`。 |
|
|
| `scope` | 经验适用范围的最小边界。 | `global`、`repository`、`module`。 |
|
|
| `category` | 用于按问题域或实践类型归类和检索。 | 自由的 kebab-case 分类，无固定枚举；当前已有 `agent-workflows`、`debugging`、`frontend-layout`。 |
|
|
| `confidence` | 基于现有证据，对经验可靠程度的判断。 | `low`、`medium`、`high`。 |
|
|
| `last_verified` | 最近一次用当前代码、运行结果、文档或其他证据核验该经验的日期；只有实际复核后才更新。 | `YYYY-MM-DD`。 |
|
|
| `promotion_target` | 该经验已经提升到或计划提升到的最小持久化执行载体；尚无目标时填 `none`。 | `none`、`global-agents`、`repo-agents`、`skill`、`test`、`lint`、`hook`、`script`、`docs`、`pattern`、`eval`。 |
|
|
| `projects` | 产生、验证或适用过该经验的项目，用于追溯证据与判断是否跨项目成立。 | YAML 字符串列表，无固定枚举；使用稳定的项目名。 |
|
|
| `tags` | 更细粒度的检索关键词，描述技术、组件、故障模式或工作流。 | YAML 字符串列表，无固定枚举；建议使用简短的 kebab-case 标签。 |
|
|
|
|
### `status` 枚举含义
|
|
|
|
| 值 | 含义 |
|
|
|---|---|
|
|
| `candidate` | 刚捕获的候选经验，已有复用信号，但证据还不足以作为稳定规则。 |
|
|
| `validated` | 已有当前、可检查的证据支持，适用边界也已确认。 |
|
|
| `promoted` | 已写入并验证某个持久化载体；具体载体记录在 `promotion_target` 和 `Promotion record` 中。 |
|
|
| `stale` | 当前真实性不确定，或已被新代码、证据、文档或执行载体否定；不能直接复用。 |
|
|
| `superseded` | 已由更新、更完整的规范经验替代；应指向替代项，避免继续作为主来源。 |
|
|
|
|
### `scope` 枚举含义
|
|
|
|
| 值 | 含义 |
|
|
|---|---|
|
|
| `global` | 跨仓库、跨项目通常成立，但复用前仍需核对当前上下文。 |
|
|
| `repository` | 只对某个仓库的命令、架构、约定或运行环境成立。 |
|
|
| `module` | 只对仓库内某个模块、组件或局部边界成立。 |
|
|
|
|
### `confidence` 枚举含义
|
|
|
|
| 值 | 含义 |
|
|
|---|---|
|
|
| `low` | 主要是初步观察或推断，证据有限，复用前需要重点验证。 |
|
|
| `medium` | 有明确实例或验证结果支持，但复现次数、覆盖范围或边界仍有限。 |
|
|
| `high` | 有强且可复查的证据，通常经过独立复现、跨项目验证，或有高严重度事件及已验证的预防机制。 |
|
|
|
|
### `promotion_target` 枚举含义
|
|
|
|
| 值 | 含义 |
|
|
|---|---|
|
|
| `none` | 尚未决定或不需要提升到其他载体。 |
|
|
| `global-agents` | 跨仓库稳定适用的个人全局 Agent 指引。 |
|
|
| `repo-agents` | 特定仓库的 `AGENTS.md` 规则或约定。 |
|
|
| `skill` | 有清晰触发条件、输入、输出和验证方式的可复用多步工作流。 |
|
|
| `test` | 用自动化测试守护可确定验证的行为或不变量。 |
|
|
| `lint` | 用静态检查规则发现可机械识别的问题。 |
|
|
| `hook` | 在提交、推送或其他生命周期节点自动执行的检查或动作。 |
|
|
| `script` | 用可重复运行的脚本固化操作、检查或修复流程。 |
|
|
| `docs` | 与项目代码或运行方式绑定的解释性文档。 |
|
|
| `pattern` | 至少经过两次独立验证的跨项目工程原则或规范模式。 |
|
|
| `eval` | 针对可复现的 Agent 行为回归建立评测用例和可观察的通过标准。 |
|
|
|
|
## 原则
|
|
|
|
- 笔记数量不是指标，行为改善才是。
|
|
- 项目事实留在项目中；这里保存索引、证据和跨项目归纳。
|
|
- 先搜索再读取，避免把整个知识库注入上下文。
|
|
- 能用测试、lint、hook 或脚本执行的规则，不只保留为文字。
|
|
- 所有经验都要说明边界和最后验证日期。
|