跳转至

AGENTS.md

《Data-Driven AI:从数据到智能》协作路由

Teach Data Engineers How to Think AI.

本文件是 AI 协作 Agent 与人类贡献者的入口。

本书的唯一真相源在 handbook/

本文件只做路由,不重复规范内容。


一、必读顺序

写任何章节前,按顺序读:

  1. handbook/BOOK_CONSTITUTION.md -- 全书宪法,最高约束
  2. handbook/ARCHITECTURE.md -- DDA 方法论与各层定义
  3. handbook/WRITING_STYLE.md -- 写作规范与 AI 写作规则
  4. handbook/GLOSSARY.md -- 全书统一术语
  5. handbook/DIAGRAM_GUIDE.md -- 图表规范

冲突时,以 handbook/ 为准。

handbook/ 内部冲突时,以 BOOK_CONSTITUTION.md 为准。


二、handbook/ 文件速查

文件 一句话职责 何时读
BOOK_CONSTITUTION.md 全书世界观、原则、边界 每次开写前
ARCHITECTURE.md DDA 各层定义与章节依赖 确定章节归属时
WRITING_STYLE.md 章节结构与 AI 写作红线 写正文时
GLOSSARY.md 术语翻译与禁止混用 用任何术语前
DIAGRAM_GUIDE.md Mermaid 与架构图规范 画图时

三、四条最硬红线

这四条是第一眼护栏,详细规则见 handbook/

  1. 不写 ChatGPT / Prompt Engineering / 模型 API 教程。
  2. 不写工具书,章节围绕 Ontology / Semantic Layer / Knowledge Foundation / Data Loop 组织。
  3. 不写模型排行榜,不讨论"哪个 LLM 更聪明"。
  4. 不逐章切换案例域,全书统一用创新药研发(Drug Discovery)。

四、贡献流程

  1. 读本文件。
  2. handbook/ 五个文件。
  3. ARCHITECTURE.md 确认章节归属层。
  4. WRITING_STYLE.md 确认章节结构。
  5. 写章节。
  6. WRITING_STYLE.md 第九章 Checklist 自检。
  7. 提交。

五、本文件的修订

本文件只做路由。

规范的增删改在 handbook/ 各文件中进行。

修订 handbook/ 后,同步本文件的速查表。