mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-19 05:48:04 +00:00
docs: make research domains actionable
- add research transfer synthesis with full 17-domain migration matrix - upgrade all research domain analysis files to actionable benchmark/iteration/validation structure - update research governance, README indexes, metadata, llms, and AI citation entries Validation: - make sync-doc-toc - make test - git diff --check - section coverage check for all 17 docs/research/*/analysis.md files Note: - welcome workflow failed because its action input names are stale; core content CI passed.
This commit is contained in:
@@ -43,6 +43,27 @@
|
||||
|
||||
动态事实不能写死成永久结论。stars、forks、release、归档状态、维护活跃度、许可证和默认分支等字段只代表观测日快照。
|
||||
|
||||
### 研究必须可迁移
|
||||
|
||||
研究域不能停在“这个对象是什么”。进入 L1 以后,研究必须继续回答:
|
||||
|
||||
- 它为什么能产生结果。
|
||||
- 哪些机制是真正有效部分。
|
||||
- 哪些做法可以迁移到本仓。
|
||||
- 哪些条件不能迁移,不能照搬。
|
||||
- 本仓应该如何改良成自己的版本。
|
||||
- 用什么最小动作验证迁移是否有效。
|
||||
|
||||
深度研究必须遵循“对标拆解 -> 改良迭代 -> 杂交创新”的转化链:
|
||||
|
||||
| 方法 | 研究问题 | 必备输出 |
|
||||
|:---|:---|:---|
|
||||
| 对标拆解 | 成熟对象为什么有效 | 参考对象、核心机制、可迁移做法、不可迁移条件、下一步试用动作 |
|
||||
| 改良迭代 | 这个机制怎样适配本仓 | 改动点、验证指标、反馈信号和下一轮方向 |
|
||||
| 杂交创新 | 多个成熟机制如何组合 | 来源机制、组合逻辑、适用条件、风险点和验证指标 |
|
||||
|
||||
如果一篇研究读完以后不能指导用户下一步行动,它还只是资料整理,不能算 L2 深度研究。
|
||||
|
||||
## 标准目录结构
|
||||
|
||||
每个长期研究域的推荐结构如下:
|
||||
@@ -73,6 +94,7 @@
|
||||
- 研究对象和研究角色。
|
||||
- 当前优先级。
|
||||
- 当前判断。
|
||||
- 用户读完能拿走什么。
|
||||
- 关键观察字段。
|
||||
- 后续观察点。
|
||||
|
||||
@@ -175,6 +197,23 @@ python3 scripts/fetch-research-raw.py openai/codex
|
||||
|
||||
raw 层拉取成功后,再把稳定事实摘要同步到 `domain.yml`;不要直接从记忆或二手总结更新 `domain.yml`。
|
||||
|
||||
### analysis.md
|
||||
|
||||
`analysis.md` 是迁移层,不是普通摘要。它必须把事实和判断转成可执行研究结论。
|
||||
|
||||
P1/P2 研究域的 `analysis.md` 必须包含:
|
||||
|
||||
- 本轮结论。
|
||||
- 本地证据。
|
||||
- 对标拆解。
|
||||
- 改良迭代。
|
||||
- 可迁移清单。
|
||||
- 不可迁移清单。
|
||||
- 验证动作。
|
||||
- 沉淀判断。
|
||||
|
||||
其中“验证动作”必须同时写成功信号和失败信号,避免研究结论不可证伪。
|
||||
|
||||
## 成熟度分级
|
||||
|
||||
研究域按成熟度推进,不要求一次写满。
|
||||
@@ -182,8 +221,8 @@ raw 层拉取成功后,再把稳定事实摘要同步到 `domain.yml`;不要
|
||||
| 级别 | 名称 | 必备产物 | 判断标准 |
|
||||
|:---|:---|:---|:---|
|
||||
| L0 | 登记 | `README.md`、`AGENTS.md`、`domain.yml`、`raw/` | 对象身份清楚,原始材料已拉取到本地且来源可复查 |
|
||||
| L1 | 理解 | `analysis.md` | 能解释架构、工作流、适用场景和风险 |
|
||||
| L2 | 验证 | `deep-dive.md`、`experiments/` 或可复现验证记录 | 关键判断经过源码阅读、本地实验或一手资料核验 |
|
||||
| L1 | 理解 | `analysis.md` | 能解释架构、工作流、适用场景、风险和初步迁移方向 |
|
||||
| L2 | 验证 | `deep-dive.md`、`experiments/` 或可复现验证记录 | 关键判断经过源码阅读、本地实验或一手资料核验,并能产出对标拆解、迁移边界和验证动作 |
|
||||
| L3 | 沉淀 | 下游 concepts / references / workflow / skills 文档 | 研究结论已经变成稳定方法、模板、流程或技能 |
|
||||
| L4 | 归档 | `archive/` 或归档说明 | 对象失效、被替代、已归档或不再值得跟踪 |
|
||||
|
||||
@@ -209,6 +248,7 @@ raw 层拉取成功后,再把稳定事实摘要同步到 `domain.yml`;不要
|
||||
|
||||
- `docs/research/README.md` 的索引判断中。
|
||||
- 新增的独立对比文档中。
|
||||
- `research-transfer-synthesis.md` 这样的迁移综合文档中。
|
||||
- 成熟后迁入 `docs/references/` 或 `docs/concepts/`。
|
||||
|
||||
禁止为了比较方便把多个研究对象塞回同一个目录。
|
||||
@@ -233,6 +273,7 @@ raw 层拉取成功后,再把稳定事实摘要同步到 `domain.yml`;不要
|
||||
- 是否存在 `README.md`、`AGENTS.md`、`domain.yml` 和 `raw/`。
|
||||
- `raw/` 是否存在 `README.md`、`AGENTS.md`、`sources.yml`、`repository/` 和至少一个原始材料文件。
|
||||
- 是否区分原始事实、事实摘要、判断、假设和决策。
|
||||
- `analysis.md` 是否包含对标拆解、改良迭代、可迁移清单、不可迁移清单和验证动作。
|
||||
- 动态事实是否有 `observed_at`、来源、核验方式和本地 raw 依据。
|
||||
- 是否避免复制外部项目全文。
|
||||
- 是否更新所有索引和机器可读入口。
|
||||
|
||||
Reference in New Issue
Block a user