-
Notifications
You must be signed in to change notification settings - Fork 1.3k
chore: sync lark-doc skill from online-doc #1727
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,8 +3,8 @@ | |||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| > **前置条件(MUST READ):** 生成文档内容前,必须先用 Read 工具读取以下文件,缺一不可: | ||||||||||||||||||||||||||||||||
| > 1. [`lark-doc-xml.md`](lark-doc-xml.md) — XML 语法规则(使用 Markdown 格式时改读 [`lark-doc-md.md`](lark-doc-md.md)) | ||||||||||||||||||||||||||||||||
| > 2. [`lark-doc-style.md`](style/lark-doc-style.md) — 排版指南(元素选择、丰富度规则、颜色语义) | ||||||||||||||||||||||||||||||||
| > 3. [`lark-doc-update-workflow.md`](style/lark-doc-update-workflow.md) — 改写增强工作流(Code-Act Loop、并行执行策略) | ||||||||||||||||||||||||||||||||
| > 2. [`lark-doc-style.md`](style/lark-doc-style.md) — 写作原则(默认段落、按体裁、组件克制) | ||||||||||||||||||||||||||||||||
| > 3. [`lark-doc-update-workflow.md`](style/lark-doc-update-workflow.md) — 改写增强工作流(Code-Act Loop、单 Agent 串行改写) | ||||||||||||||||||||||||||||||||
| > | ||||||||||||||||||||||||||||||||
| > **未读完以上文件就生成内容会导致格式错误。** | ||||||||||||||||||||||||||||||||
|
Comment on lines
4
to
9
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Add the whiteboard guide to the MUST READ list for update flows.
Suggested fix > 1. [`lark-doc-xml.md`](lark-doc-xml.md) — XML 语法规则(使用 Markdown 格式时改读 [`lark-doc-md.md`](lark-doc-md.md))
> 2. [`lark-doc-style.md`](style/lark-doc-style.md) — 写作原则(默认段落、按体裁、组件克制)
-> 3. [`lark-doc-update-workflow.md`](style/lark-doc-update-workflow.md) — 改写增强工作流(Code-Act Loop、单 Agent 串行改写)
+> 3. [`lark-doc-whiteboard.md`](lark-doc-whiteboard.md) — 画板语法、插入与更新规则
+> 4. [`lark-doc-update-workflow.md`](style/lark-doc-update-workflow.md) — 改写增强工作流(Code-Act Loop、单 Agent 串行改写)📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
|
|
@@ -232,7 +232,7 @@ lark-cli docs +update --doc "<doc_id>" --command str_replace \ | |||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| > **`docs +update` 不能直接编辑已有画板的内容。** 本命令只能**新增**画板块;要修改已有画板,先用 `docs +fetch` 取到 `<whiteboard token="...">`,再按 [`lark-doc-whiteboard.md`](lark-doc-whiteboard.md) 启动 SubAgent 读取 [`lark-whiteboard`](../../lark-whiteboard/SKILL.md) 并写入。 | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| 画板的语法选型与插入示例见 [`lark-doc-style.md`](style/lark-doc-style.md) 的「画板语法与插入」章节。 | ||||||||||||||||||||||||||||||||
| 画板的语法选型与插入示例见 [`lark-doc-xml.md`](lark-doc-xml.md) 与 [`lark-doc-whiteboard.md`](lark-doc-whiteboard.md)。 | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ## 最佳实践 | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
|
|
@@ -252,8 +252,8 @@ lark-cli docs +update --doc "<doc_id>" --command str_replace \ | |||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ## 参考 | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| - [`lark-doc-update-workflow.md`](style/lark-doc-update-workflow.md) — 改写增强工作流(Code-Act Loop、并行执行策略) | ||||||||||||||||||||||||||||||||
| - [`lark-doc-style.md`](style/lark-doc-style.md) — 文档样式指南(元素选择 + 丰富度规则 + 颜色语义) | ||||||||||||||||||||||||||||||||
| - [`lark-doc-update-workflow.md`](style/lark-doc-update-workflow.md) — 改写增强工作流(Code-Act Loop、单 Agent 串行改写) | ||||||||||||||||||||||||||||||||
| - [`lark-doc-style.md`](style/lark-doc-style.md) — 文档写作原则(默认段落、按体裁、组件克制) | ||||||||||||||||||||||||||||||||
| - [`lark-doc-xml.md`](lark-doc-xml.md) — XML 语法规范 | ||||||||||||||||||||||||||||||||
| - [`lark-doc-fetch.md`](lark-doc-fetch.md) — 获取文档 | ||||||||||||||||||||||||||||||||
| - [`lark-doc-create.md`](lark-doc-create.md) — 创建文档 | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add the whiteboard guide to the MUST READ list.
The create flow now has whiteboard insertion responsibilities elsewhere in the skill, but this preflight still only covers XML/style/create-workflow. A caller can satisfy the current checklist and still miss the board syntax/insertion rules.
Suggested fix
📝 Committable suggestion
🤖 Prompt for AI Agents