From 78c8f83419df5be7a8ec778ab509fe1ddb8bc8ab Mon Sep 17 00:00:00 2001 From: DKChan <524912269@qq.com> Date: Sat, 31 Oct 2026 06:15:08 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3(=E8=BD=BD=E4=BD=93=E9=BB=98?= =?UTF-8?q?=E8=AE=A4=E6=8D=A2=E4=BB=A3=E6=89=B9=C2=B7=E7=94=A8=E6=88=B7?= =?UTF-8?q?=E8=A3=81):=20=E5=9B=BE=E4=BC=98=E5=85=88=E8=BD=BD=E4=BD=93?= =?UTF-8?q?=E9=BB=98=E8=AE=A4=20HTML+SVG=E2=80=94=E2=80=94AGENTS.md=20?= =?UTF-8?q?=E8=BD=BD=E4=BD=93=E5=8F=A5=E6=8D=A2=E4=BB=A3(=E9=BB=98?= =?UTF-8?q?=E8=AE=A4=20visualize=20=E6=8A=80=E8=83=BD=20HTML/SVG=20?= =?UTF-8?q?=E5=86=85=E8=81=94=E6=B8=B2=E6=9F=93=C2=B7=E6=B5=81=E7=A8=8B?= =?UTF-8?q?=E7=BB=93=E6=9E=84=E5=9B=BE=E4=B8=8E=E7=A9=BA=E9=97=B4=E5=AF=B9?= =?UTF-8?q?=E6=AF=94=E5=83=8F=E7=B4=A0=E7=A4=BA=E6=84=8F=E5=90=8C=E4=B8=80?= =?UTF-8?q?=E9=80=9A=E9=81=93=C2=B7=E6=97=A0=E5=86=85=E8=81=94=E6=B8=B2?= =?UTF-8?q?=E6=9F=93=E9=80=80=20Mermaid=C2=B7=E5=86=8D=E9=80=80=E5=AD=97?= =?UTF-8?q?=E7=AC=A6=E7=94=BB)+doc-conventions=20=C2=A73=20=E6=B5=81?= =?UTF-8?q?=E7=A8=8B=E8=A1=8C=E6=8D=A2=E4=BB=A3(=E9=BB=98=E8=AE=A4?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=86=85=E5=B5=8C=20HTML/SVG=20=E8=A1=A8?= =?UTF-8?q?=E7=8E=B0=E5=8A=9B=E4=BC=98=E5=85=88=C2=B7=E5=9B=BE=E4=BD=93?= =?UTF-8?q?=E8=A1=8C=E6=95=B0=E8=AE=A1=E5=85=A5=E8=8A=82=E7=82=B9=E7=AF=87?= =?UTF-8?q?=E5=B9=85=C2=B7=E8=BF=87=E6=BB=A4=E5=9E=8B=E7=BD=91=E9=A1=B5?= =?UTF-8?q?=E7=AB=AF=E6=94=B9=20Mermaid=C2=B7=E6=97=A0=E6=B8=B2=E6=9F=93?= =?UTF-8?q?=E7=8E=AF=E5=A2=83=E5=AD=97=E7=AC=A6=E7=94=BB)+=E8=8A=82?= =?UTF-8?q?=E7=82=B9=E5=86=85=E9=A1=BA=E5=BA=8F=E5=8F=A5=E9=9A=8F=E6=94=B9?= =?UTF-8?q?;2026-10-31=20=E7=94=A8=E6=88=B7=E8=A3=81,=E7=90=86=E7=94=B1=3D?= =?UTF-8?q?=E8=A1=A8=E7=8E=B0=E6=95=88=E6=9E=9C=E6=9B=B4=E5=A5=BD,?= =?UTF-8?q?=E6=8E=A5=E5=8F=97=E7=BD=91=E9=A1=B5=E7=AB=AF=E8=BF=87=E6=BB=A4?= =?UTF-8?q?=E5=86=85=E5=B5=8C=20SVG=20=E4=B8=8E=20git=20diff=20=E5=8F=AF?= =?UTF-8?q?=E8=AF=BB=E6=80=A7=E4=BB=A3=E4=BB=B7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 2 +- design/engineering/doc-conventions.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index a8a1f2ac..ba1932c0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -83,7 +83,7 @@ **判据**：描述含多个实体、实体间有明确关系（先后顺序、包含、依赖、状态转移、布局对比）的内容时，直接画图说明，不写长段文字；单点事实（一句装得下）不画，纯数据对照用表格。 -**载体**：节点连边图（流程/状态/结构/实体关系）默认用 Mermaid 代码块；需要空间对比、像素级示意、界面草图时用 visualize 技能出 HTML/SVG；查看端不支持渲染时退回字符画。 +**载体**：默认用 visualize 技能出 HTML/SVG（会话内联渲染，表现力优先），流程/状态/结构/实体关系与空间对比、像素级示意、界面草图同一通道；查看端不支持内联渲染时退回 Mermaid 代码块，仍不行用字符画。 **边界**：硬数值与前提条件留在文字里，图不承载唯一数值依据；图与文禁重复说同一件事，文字只留图说不清的部分。 diff --git a/design/engineering/doc-conventions.md b/design/engineering/doc-conventions.md index 24adccdf..80efd0c8 100644 --- a/design/engineering/doc-conventions.md +++ b/design/engineering/doc-conventions.md @@ -30,11 +30,11 @@ |---|---|---| | 规则的来龙去脉、行为逻辑 | 散文段 | 每段 ≤240 字，一段一件事 | | 枚举、数值、边界、依赖 | 表格 | 表格只放可列举的事实；禁把需要解释的内容塞进单元格让读者自己拼 | -| 流程、状态流转、结构关系 | 字符画或 Mermaid 代码块 | 禁用散文逐步描述流程；多分支状态机、实体关系、模块依赖这类复杂结构图优先 Mermaid（源码即文本，查看端不渲染也可读可改），简单线性流程与无渲染查看环境用字符画 | +| 流程、状态流转、结构关系 | 文档内嵌 HTML/SVG（默认）· Mermaid（网页发布保底）· 字符画（无渲染环境保底） | 禁用散文逐步描述流程；默认在文档内嵌 HTML/SVG（表现力优先，本地预览即渲染，图体行数计入节点篇幅）；发布到会过滤内嵌 HTML 的网页端时改 Mermaid；无渲染查看环境用字符画 | | 公式 | 结论先行 | 先一行加粗结论，再放公式代码块、变量表与验算表 | | 体验锚点 | 关键词表 | 支柱/关键词/机制承诺 三列表，禁长篇情绪描述 | -节点内顺序：先人话，再表格枚举，再流程图（字符画或 Mermaid），最后公式举证。**规则两段式**：先写"人话阶段"（作用于哪个系统、什么情况下、谁触发、触发后发生什么），再写"举证阶段"（逐效果给出计算方法；纯流程规则明写"无计算"）。规则名禁止纯名词短语（反面例："获取路由"）。 +节点内顺序：先人话，再表格枚举，再流程图（内嵌 HTML/SVG 或字符画），最后公式举证。**规则两段式**：先写"人话阶段"（作用于哪个系统、什么情况下、谁触发、触发后发生什么），再写"举证阶段"（逐效果给出计算方法；纯流程规则明写"无计算"）。规则名禁止纯名词短语（反面例："获取路由"）。 ## 4. 用语纪律（见名知意 · 所见即所得 · 禁自造黑话）