nangongwentian-fe/lark-beautiful-docs

飞书文档富文本排版 Skill

核心原则：每节都要有视觉锚点

禁止纯文字墙。 任何超过 3 行的内容块都必须加入至少一个视觉元素。

| 内容类型 | 必用元素 | |---------|---------| | 重要提示 / 注意事项 / 结论 | <callout> 高亮块 | | 并列对比 / 左右分区 | <grid> 分栏 | | 多列结构化数据（含代码/列表） | <lark-table> 增强表格 | | 流程 / 架构 / 草图 | <whiteboard> 画板 | | 命令 / 代码 | 代码块 ``` + 语言标注 | | 关键术语 / 强调词 | <text color="..."> 行内染色 | | 纯文字数据对比（≤3列） | Markdown 标准表格 \|---| |

快速决策：用哪个元素

有重要提示 → callout 颜色速查：💡light-blue 提示 | ⚠️light-yellow 警告 | ❌light-red 危险 | ✅light-green 成功 | 📌pale-gray 备注

有对比 / 并排内容 → grid 2列 左栏放"旧/问题/方式A"，右栏放"新/方案/方式B"

有工具/选项列表，且单元格含代码 → lark-table 纯文字表格直接用 Markdown |---|，lark-table 只在需要富文本单元格时用

有流程步骤 → 有序列表 + 代码块组合 复杂架构图才用画板，简单流程用带缩进的有序列表

有重要词汇 → 行内染色 <text color="blue">关键术语</text> 或 <text background-color="yellow">高亮</text>

文档结构规则

1. 开头必有 callout — 1-2 句说明文档目的和读者对象
2. 每个 H2 章节内至少一个非纯文字元素（表格/分栏/callout/代码块之一）
3. 对比场景必用分栏 — "传统 vs 新"、"优点 vs 缺点"、"方案A vs 方案B"
4. 数据超过 3 行键值对 → 表格，不用列表
5. 结尾用 callout 或 --- 收尾，不要让文档"断"在普通段落

文档类型模板

根据内容类型加载对应模板：

• templates.md — 技术探索、项目方案、会议纪要、状态报告的完整骨架
• element-guide.md — 各元素详细语法 + 组合模式 + 反例

与 lark-doc 协作

本 skill 决定内容结构和视觉设计，lark-doc 执行 lark-cli docs +create / +update。

写之前先问三个问题：

• 这节是数据/对比 → 表格或分栏
• 这节是注意/结论 → callout
• 这节是步骤/流程 → 有序列表 + 代码块