diff --git a/AGENTS.md b/AGENTS.md index 9be8b476..a8a1f2ac 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -77,7 +77,15 @@ ### 格式优先级 -枚举用列表,二维对照用表格,按内容形态选;散文是最后手段。 +能画图的内容一律画图说明,图是第一优先载体;枚举用列表,二维对照用表格;散文是最后手段。 + +### 图优先 + +**判据**:描述含多个实体、实体间有明确关系(先后顺序、包含、依赖、状态转移、布局对比)的内容时,直接画图说明,不写长段文字;单点事实(一句装得下)不画,纯数据对照用表格。 + +**载体**:节点连边图(流程/状态/结构/实体关系)默认用 Mermaid 代码块;需要空间对比、像素级示意、界面草图时用 visualize 技能出 HTML/SVG;查看端不支持渲染时退回字符画。 + +**边界**:硬数值与前提条件留在文字里,图不承载唯一数值依据;图与文禁重复说同一件事,文字只留图说不清的部分。 ## 主动检索提醒 diff --git a/design/engineering/doc-conventions.md b/design/engineering/doc-conventions.md index 8d5f9bb9..24adccdf 100644 --- a/design/engineering/doc-conventions.md +++ b/design/engineering/doc-conventions.md @@ -18,7 +18,7 @@ 写文档像向朋友当面解释你的游戏: 1. **完整句子优先**:一段只说一件事,长句拆短句。 -2. **禁止碎片笔记体**:不写压缩碎片,不把 `A→B→C` 箭头链当叙述(流程交给字符画,见第 3 节),不用只有作者自己懂的缩略语。 +2. **禁止碎片笔记体**:不写压缩碎片,不把 `A→B→C` 箭头链当叙述(流程交给图,见第 3 节),不用只有作者自己懂的缩略语。 3. **每节人话开头**:每小节第一段先用白话说清"这是什么、为什么需要它";只读各节第一段就能看懂全文故事线。 4. **术语首现即解释**:专业术语或项目概念首次出现用一句话解释;玩家可见专属名词(如"显影尘")同样要说清。 5. **叙述优先于引用**:AC-x、F-x 等编号引用不进正文叙述,只出现在验收标准与附录。 @@ -30,11 +30,11 @@ |---|---|---| | 规则的来龙去脉、行为逻辑 | 散文段 | 每段 ≤240 字,一段一件事 | | 枚举、数值、边界、依赖 | 表格 | 表格只放可列举的事实;禁把需要解释的内容塞进单元格让读者自己拼 | -| 流程、状态流转 | 字符画(代码块) | 禁用散文逐步描述流程 | +| 流程、状态流转、结构关系 | 字符画或 Mermaid 代码块 | 禁用散文逐步描述流程;多分支状态机、实体关系、模块依赖这类复杂结构图优先 Mermaid(源码即文本,查看端不渲染也可读可改),简单线性流程与无渲染查看环境用字符画 | | 公式 | 结论先行 | 先一行加粗结论,再放公式代码块、变量表与验算表 | | 体验锚点 | 关键词表 | 支柱/关键词/机制承诺 三列表,禁长篇情绪描述 | -节点内顺序:先人话,再表格枚举,再字符流程图,最后公式举证。**规则两段式**:先写"人话阶段"(作用于哪个系统、什么情况下、谁触发、触发后发生什么),再写"举证阶段"(逐效果给出计算方法;纯流程规则明写"无计算")。规则名禁止纯名词短语(反面例:"获取路由")。 +节点内顺序:先人话,再表格枚举,再流程图(字符画或 Mermaid),最后公式举证。**规则两段式**:先写"人话阶段"(作用于哪个系统、什么情况下、谁触发、触发后发生什么),再写"举证阶段"(逐效果给出计算方法;纯流程规则明写"无计算")。规则名禁止纯名词短语(反面例:"获取路由")。 ## 4. 用语纪律(见名知意 · 所见即所得 · 禁自造黑话)