From 65f92609763235cec7f4e53a8a678cbb58b77a0d Mon Sep 17 00:00:00 2001 From: fangshuyu Date: Thu, 2 Jul 2026 14:28:34 +0800 Subject: [PATCH] docs: consolidate workflow style checks --- .../references/style/lark-doc-create-workflow.md | 9 +-------- skills/lark-doc/references/style/lark-doc-style.md | 10 +++++----- .../references/style/lark-doc-update-workflow.md | 7 +------ 3 files changed, 7 insertions(+), 19 deletions(-) diff --git a/skills/lark-doc/references/style/lark-doc-create-workflow.md b/skills/lark-doc/references/style/lark-doc-create-workflow.md index 3f59a525..c3448bf5 100644 --- a/skills/lark-doc/references/style/lark-doc-create-workflow.md +++ b/skills/lark-doc/references/style/lark-doc-create-workflow.md @@ -33,12 +33,7 @@ ### 步骤二：整合审查与画板识别（串行） 4. `docs +fetch --api-version v2 --detail with-ids` 获取文档，审查整体效果 -5. 评估内容是否满足用户目标：事实是否完整、结构是否清楚、语气是否匹配、是否保留必要素材；检查跨节有无重复、矛盾或断流。再按 `lark-doc-style.md` 的写作原则**逐节核对**，发现问题就地定向修正： - - **去列举**：叙述性内容（背景 / 现状 / 认识 / 分析 / 成效等）是否被做成了列举？是则改成段落；列举只留给真正并列的具体措施 / 步骤 / 清单。 - - **查"通篇一是二是"**：是不是每个方面 / 每节都齐刷刷"一是 / 二是 / 三是"、几乎没有叙述段落？是则给背景 / 认识 / 分析 / 过渡补上段落，「一是 / 二是」只收到列具体问题 / 措施那一处（纯清单 / 台账类除外）。 - - **查编号**：全篇是否一套、不跳号、不跳级；**有没有中文序号 + 阿拉伯小数混用（一、+ 1.1）**。 - - **查呈现**：成行成列的数据是否该用表格却写成了段落 / "A+B+C"串？"小标题 + 一句话"的小项是否被升成了标题？是则按 `lark-doc-style.md` §二改成表格 / 标签行 / 加粗引导句段落。 - - **查组件**：高亮块 / 分栏 / 画板 / 颜色是否克制、符合体裁。 +5. 评估内容是否满足用户目标：事实是否完整、结构是否清楚、语气是否匹配、是否保留必要素材；检查跨节有无重复、矛盾或断流。再按 `lark-doc-style.md` 的「写完自检」快速核对，发现问题就地定向修正 6. **画板识别**：逐章节扫描，判断是否有段落用图明显比文字更易懂（流程 / 架构 / 时间线 / 对比 / 占比等，见 `lark-doc-style.md` 的画板原则）。默认用文字，只有确需图示才记录需要插图的章节、推荐画板类型、mermaid/SVG 路径和用于画图的源内容 ### 步骤三：画板处理与润色 @@ -50,8 +45,6 @@ 9. 仅当用户预期需要校验字数时，才读取并执行 [`lark-doc-word-stat.md`](../lark-doc-word-stat.md) 的「字数遵循校验」；否则跳过本项，不读取该 workflow。若执行了专项校验，向用户呈现结果 -## Agent 子任务要求 - ## 画板 SubAgent 子任务要求 Mermaid 图由主 Agent 直接插入 `...`，无需 SubAgent。 diff --git a/skills/lark-doc/references/style/lark-doc-style.md b/skills/lark-doc/references/style/lark-doc-style.md index 70799f7e..e67f4333 100644 --- a/skills/lark-doc/references/style/lark-doc-style.md +++ b/skills/lark-doc/references/style/lark-doc-style.md @@ -52,8 +52,8 @@ ## 六、写完自检 交付前快速回看： -- 该成段的叙述是否被拆成了列表 / 序号？是否**每节都机械"一是 / 二是"、缺叙述**？ -- 成行成列的**数据是否该用表格**、却写成了段落或"A+B+C"串？ -- **"小标题 + 一句话"的小项是否被升成了标题**（目录里一堆没信息量的条目）？ -- 编号是否全篇一套、**没有中文 + 阿拉伯混用（一、+ 1.1）**、无跳号跳级？ -- 高亮块 / 分栏 / 画板 / 颜色是否克制、符合体裁？引用 / 图片 / 资源块是否保留？用户点名要的格式是否照做？ +- **叙述是否被列举化**：背景 / 现状 / 认识 / 分析 / 成效 / 过渡 / 总结等应成段；列举只留给真正并列的具体问题 / 措施 / 步骤 / 清单。若每个方面 / 每节都机械"一是 / 二是 / 三是"、几乎没有叙述段落，给背景 / 认识 / 分析 / 过渡补上段落（纯清单 / 台账类除外）。 +- **数据是否正确呈现**：成行成列的数据应改成表格，不要写成段落或"A+B+C"串。 +- **标题是否滥用**："小标题 + 一句话"的小项不要升成标题；按 §二改成标签行 / 加粗引导句段落。 +- **编号是否统一**：全篇一套、不跳号、不跳级，尤其不要中文 + 阿拉伯混用（如「一、」配「1.1」）。 +- **组件是否克制且保真**：高亮块 / 分栏 / 画板 / 颜色应符合体裁和用户要求；引用 / 图片 / 资源块必须保留。 diff --git a/skills/lark-doc/references/style/lark-doc-update-workflow.md b/skills/lark-doc/references/style/lark-doc-update-workflow.md index 90484383..5f753bb0 100644 --- a/skills/lark-doc/references/style/lark-doc-update-workflow.md +++ b/skills/lark-doc/references/style/lark-doc-update-workflow.md @@ -39,12 +39,7 @@ ### 步骤三：验证（串行） 7. 获取更新后文档局部内容，检查是否符合用户目标和已有风格 -8. 检查是否满足用户目标并保留原有关键内容。再按 `lark-doc-style.md` 的写作原则**逐节核对**，发现问题则定向修正： - - **去列举**：叙述性内容（背景 / 现状 / 认识 / 分析 / 成效等）是否被做成了列举？是则改成段落；列举只留给真正并列的具体措施 / 步骤 / 清单。 - - **查"通篇一是二是"**：是不是每个方面 / 每节都齐刷刷"一是 / 二是 / 三是"、几乎没有叙述段落？是则给背景 / 认识 / 分析 / 过渡补上段落，「一是 / 二是」只收到列具体问题 / 措施那一处（纯清单 / 台账类除外）。 - - **查编号**：全篇是否一套、不跳号、不跳级；**有没有中文序号 + 阿拉伯小数混用（一、+ 1.1）**。 - - **查呈现**：成行成列的数据是否该用表格却写成了段落 / "A+B+C"串？"小标题 + 一句话"的小项是否被升成了标题？是则按 `lark-doc-style.md` §二改成表格 / 标签行 / 加粗引导句段落。 - - **查组件**：高亮块 / 分栏 / 画板 / 颜色是否克制、符合体裁。 +8. 检查是否满足用户目标并保留原有关键内容。再按 `lark-doc-style.md` 的「写完自检」快速核对，发现问题则定向修正 ### 步骤四：专项校验（按需执行）