From c36f97d77895d7796d92b756377215b8132e1b8f Mon Sep 17 00:00:00 2001 From: DKChan <524912269@qq.com> Date: Sun, 25 Oct 2026 19:11:04 +0800 Subject: [PATCH] =?UTF-8?q?docs(=E8=A7=84=E5=88=99=E4=BF=AE=E8=AE=A2):=20?= =?UTF-8?q?=E8=A7=84=E8=8C=83=E5=AF=BC=E8=88=AA=E8=A7=A6=E5=8F=91=E5=89=8D?= =?UTF-8?q?=E7=A7=BB=E2=80=94=E2=80=94=E8=AF=BB=E8=A7=84=E5=88=99=E4=BB=8E?= =?UTF-8?q?=E3=80=8C=E5=86=99X=E5=89=8D=E3=80=8D=E6=8F=90=E5=89=8D?= =?UTF-8?q?=E5=88=B0=E3=80=8C=E5=AE=9AX=E6=96=B9=E6=A1=88=E5=89=8D?= =?UTF-8?q?=E3=80=8D=EF=BC=9AAGENTS.md=20=E6=96=87=E9=A6=96=E6=8C=87?= =?UTF-8?q?=E9=92=88=E4=B8=8E=E5=AF=BC=E8=88=AA=E8=A1=A8=E5=A4=B4=E6=94=B9?= =?UTF-8?q?=E3=80=8C=E5=AE=9A=E6=96=B9=E6=A1=88=E5=89=8D=E5=85=88=E6=9F=A5?= =?UTF-8?q?=EF=BC=88=E7=A1=AE=E8=AE=A4=E5=86=99=E4=BB=80=E4=B9=88=E5=86=85?= =?UTF-8?q?=E5=AE=B9=E4=B9=8B=E5=89=8D=E8=AF=BB=E8=A7=84=E5=88=99=EF=BC=8C?= =?UTF-8?q?=E4=B8=8D=E6=98=AF=E5=8A=A8=E6=89=8B=E5=89=8D=E6=89=8D=E8=AF=BB?= =?UTF-8?q?=EF=BC=89=E3=80=8D=EF=BC=8B=E4=BB=A3=E7=A0=81/=E6=B5=8B?= =?UTF-8?q?=E8=AF=95/=E6=96=87=E6=A1=A3=E4=B8=89=E8=A1=8C=E6=97=B6?= =?UTF-8?q?=E6=9C=BA=E6=A0=BC=E5=90=84=E5=89=8D=E7=BD=AE=E3=80=8C=E5=AE=9A?= =?UTF-8?q?X=E6=96=B9=E6=A1=88=E3=80=8D=E6=AE=B5=EF=BC=8Cdoc-conventions?= =?UTF-8?q?=20=E6=96=87=E9=A6=96=E6=A0=87=E9=A2=98=E3=80=8C=E5=86=99?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=89=8D=E5=BF=85=E8=AF=BB=E3=80=8D=E6=94=B9?= =?UTF-8?q?=E3=80=8C=E5=AE=9A=E6=96=87=E6=A1=A3=E6=96=B9=E6=A1=88=E5=89=8D?= =?UTF-8?q?=E5=BF=85=E8=AF=BB=E3=80=8D=EF=BC=882026-10-25=20=E7=94=A8?= =?UTF-8?q?=E6=88=B7=E8=A3=81=EF=BC=9B=E8=B5=B7=E5=9B=A0=EF=BC=9D=E6=9E=B6?= =?UTF-8?q?=E6=9E=84=E5=AF=B9=E9=BD=90=E4=BC=9A=E8=AF=9D=E8=AE=A8=E8=AE=BA?= =?UTF-8?q?=E6=9C=9F=E6=9C=AA=E8=AF=BB=E8=A7=84=E7=BA=A6=E6=8B=BC=E6=96=B9?= =?UTF-8?q?=E6=A1=88=E3=80=81=E8=A1=A5=E8=AF=BB=E5=90=8E=E4=B8=A4=E5=A4=84?= =?UTF-8?q?=E8=BF=9D=E4=BE=8B=E6=92=A4=E5=9B=9E=E2=80=94=E2=80=94=E6=97=A7?= =?UTF-8?q?=E8=A7=A6=E5=8F=91=E8=AF=8D=E5=8F=AA=E7=AE=A1=E5=86=99=E3=80=81?= =?UTF-8?q?=E6=B2=A1=E7=AE=A1=E4=BD=8F=E5=AE=9A=E6=96=B9=E6=A1=88=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 10 +++++----- design/engineering/doc-conventions.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 1226851d..12f662b5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -3,7 +3,7 @@ 扫雷推理层 + 自动战斗结算的两段式回合 Roguelike。个人开发，MVP 优先管线。 设计入口：`design/gdd/02-系统清单.md`（根索引）· 概念：`design/gdd/00-游戏概念.md` -> 本文件只保留全局元信息与硬性红线索引；领域细则在子文档，动手前先查「规范导航」。 +> 本文件只保留全局元信息与硬性红线索引；领域细则在子文档，定方案前先查「规范导航」。 ## Technology Stack @@ -36,15 +36,15 @@ - `reports/` — 过程件容器：**需求卡片**（写卡段产出，实现批的输入合同）＋迭代批产出物（实现报告/代拍板追认单/GDD 反哺点清单）＋设计讨论段过程稿（提案/审计/需求澄清/评估）；**实现批唯一可写目录**，中间文档唯一容器（`design/research/` 已退役），不是事实源（细则见 `reports/README.md`） - 根目录：`README.md`（纯指路牌：设计/流程/当前位/待办四个链接，零规则重述）、`roadmap.md`（里程碑＋迭代总表六列＋顶部「当前位」节＝现在做什么）、`待办清单.md`（流水线唯一登记处，条目级待办与状态）、`体验验证清单.md`（需真人试玩才能下结论的验证项）、`stage.txt`/`review-mode.txt`（运行开关）、`playnote.md`（用户本人试玩随手记，只由用户增删，不属任何文档族）；仓库根禁止再设会话状态文件（细则见 doc-conventions 第 10 节） -## 规范导航（动手前先查表） +## 规范导航（定方案前先查表——确认写什么内容之前读规则，不是动手前才读） | 时机 | 权威文档 | |---|---| | 批次开工 / 流程纪律 | `design/engineering/process-conventions.md`——worktree 铁律、五段流水线、批次清单、测试两入口与 MC/闸机细则、像素纪律 | | 流水线段入口 | 技能对照——doc-design=文档设计（兼任反哺点落文）／asset-ingest=美术录入／req-card=写卡／iter-plan=迭代编排／iter=实现（五者均装于项目 `.zcode/skills/`）；登记不立技能；批后收尾与中间文档退役=batch-closure（同一目录）；格式与状态机权威=`design/engineering/doc-conventions.md` §12 | -| 写代码 / 改代码前 | `design/engineering/code-conventions.md`——结构/契约/语言/数值/流程五类硬纪律（反例库 = 同目录 code-conventions-cases.md） | -| 写测试 / 改测试前 | `design/engineering/test-conventions.md`——探针标配 / 回归断言 / 全量验证 / 验收清单落码 | -| 写文档 / 改文档前 | `design/engineering/doc-conventions.md`——白话写作 / 载体分工 / 用语 / 结构骨架 / 会话记录与生命周期 | +| 定代码方案 / 写代码 / 改代码前 | `design/engineering/code-conventions.md`——结构/契约/语言/数值/流程五类硬纪律（反例库 = 同目录 code-conventions-cases.md） | +| 定测试方案 / 写测试 / 改测试前 | `design/engineering/test-conventions.md`——探针标配 / 回归断言 / 全量验证 / 验收清单落码 | +| 定文档方案 / 写文档 / 改文档前 | `design/engineering/doc-conventions.md`——白话写作 / 载体分工 / 用语 / 结构骨架 / 会话记录与生命周期 | | 概念切分与互链 | `design/engineering/concept-conventions.md`——概念封装 / 跨文档引用 / 归档与事实源 | | 系统设计 / 增删文档 | `design/gdd/02-系统清单.md`——根索引 + 中文规范名↔英文代号对照 | | 架构（唯一事实源） | `design/engineering/architecture/architecture.md`——历史决策沿革查 git commit log，不另设决策文档 | diff --git a/design/engineering/doc-conventions.md b/design/engineering/doc-conventions.md index fc2d36bb..cb333f1a 100644 --- a/design/engineering/doc-conventions.md +++ b/design/engineering/doc-conventions.md @@ -1,4 +1,4 @@ -# 文档写作规范（写文档前必读） +# 文档写作规范（定文档方案前必读） > **地位**：本文是文档写作的规范权威，与 `design/engineering/code-conventions.md`（代码规范）对等；AGENTS.md 只留导航指针，细则以本文为准。 > **适用范围**：`design/` 下一切现行文档与根目录 `roadmap.md`；概念建模与跨文档引用见 `design/engineering/concept-conventions.md`。