Files
CADx-4/research-wiki/README.md
T
iomgaa 1f7a6a3d9c docs: 协作规则、工作记录与 research-wiki 文档体系
从产品重构为研究原型的第一步(负责人 2026-10-15:「其其实不需要(至少目前不需要)
是一个工程产品」)。协作环境照 ClinDB-ReviewBench(负责人点名参考)。

- AGENTS.md 为唯一规则,CLAUDE.md 只引用它;硬性约束保留旧项目的答案隔离、各路隔离,
  加上数字可追溯、花钱先报预估等
- WORK_LOG.md 记当前状态与负责人的关键决定
- research-wiki:README、explanation/结构.md(8 个模块、依赖边界、推进顺序)、
  design/0001(为什么重构、继承与放弃什么、单一 uv 环境)、guides/开发环境.md
- 三份新文档过了一轮「硕士生阅读」并按意见修订

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 23:42:37 -04:00

23 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# research-wiki
本项目的文档。读者是没参与过讨论的医学 AI 方向硕士生:懂 Python 和深度学习,不懂胰腺囊性肿瘤。
| 位置 | 内容 | 维护方式 |
|---|---|---|
| `explanation/` | 系统由哪些环节组成、各环节的输入输出、为什么这样分。从 `结构.md` 读起 | 常青:改了就重写那一段 |
| `design/` | 每次重要决策的来历,文件名 `NNNN-简短主题.md` | 写完冻结;决策变了新写一份并注明取代关系 |
| `guides/` | 怎么做某件事:建环境、跑某个环节 | 常青,随实际情况更新 |
| `reference/` | 查得到的外部事实:术语表、算法参数的原始口径、临床方给的字段定义。每条自带出处;抄自 Linear 的写明抄自哪份、哪天同步 | 常青,随出处更新 |
| `任务书/` | 每个模块动手前的任务书,文件名 `NN-模块名.md`:要做什么、依据哪些文档、怎么验收 | 负责人确认后交执行者;要改就在开头写「这一版改了什么」 |
| `survey/` | 文献调研:同类工作怎么做、对我们意味着什么,引文带 PDF 页码(PDF 在根目录 `reference-pdf/`,不进 git) | 写完冻结;有新调研另写一份 |
| `results/` | 实验结果报告,每个数字标明来自哪次运行(`runs/` 下的目录名) | 写完冻结 |
| `scratch/` | 讨论中的草稿、上下文压缩前的快照 | 由负责人清理,Agent 不删 |
## 几类文档的开头
不用 YAML 头,靠固定的开头段落:
- **design**:`# NNNN 标题` → `状态:负责人 YYYY-MM-DD 认可(「原话」) | 日期:…` → 取代了谁就写一行 `> 取代 NNNN 的第 X 条` → `## 先认识几个词` → `## 背景` → `## 决定`(编号条目,写明哪条是负责人定的、哪条是 Agent 提的) → 需要时加 `## 不做的事`。
- **任务书**:标题 → 一段目的 → `来源:`(负责人原话) → `## 先认识几个词` → `## 开工前先读` → 分阶段的工作内容(每阶段写收尾点) → `## 测试` → `## 规模` → `## 审阅` → `## 报告`(分开写已验证的事实、推断和未验证的部分,附运行目录、提交号、花费)。
- **results**:`日期 | 对应结构.md 第六节第 N 步 | 原始记录:runs/…` → `## 先认识几个词` → `## 一 跑了什么` → 结果,每个数字带运行目录。