跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 review-docs

Review Docs

对照语音和道克向导审查并改进所绘制的 SDK 文档,对每篇文章进行评分并延后到通过. 当被要求审查文件时使用, 审计 apps/ docs/ Content 中的一篇文章, 检查文档是否遵循样式指南, 或改进现有的文档 .

387 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

对照语音和docs向导审查和改进所绘制的 SDK 文档,对每篇文章进行评分并进行延后到通过

何时用

- 说吧 问题很简单

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Review documentation、Workflow overview、State file、Review tracker: [filename]、Issue tracker、Round history。 其中含规范建议的小节:分步指令。

文件分析

文件分析:这是一份仅含 SKILL.md 的指令型技能,代理激活后整份正文进入上下文。

官方 description(原文)

Review and improve tldraw SDK documentation against the voice and docs guides, scoring each article and iterating until it passes. Use when asked to review docs, audit an article in apps/docs/content, check whether documentation follows the style guide, or improve existing documentation.

Review documentationWorkflow overviewState fileReview tracker: [filename]Issue trackerRound historyRound 1Step 1: Initial evaluationStyle agent prompt (round 1)Content agent prompt (round 1)Step 2: Summarize and prompt userEvaluation: [filename]

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
review-docs
description
Review and improve tldraw SDK documentation against the voice and docs guides, scoring each article and iterating until it passes. Use when asked to review docs, audit an article in apps/docs/content, check whether documentation follows the style guide, or improve existing documentation.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「review-docs」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-5c6988c9ea613ebe-%E5%AE%A1%E6%9F%A5%E6%96%87%E4%BB%B6.html
请存为 .cursor/skills/review-docs/SKILL.md 或 .claude/skills/review-docs/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/tldraw/tldraw' --list

npx skills add 'https://github.com/tldraw/tldraw' --skill 'review-docs'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版
--- name: review-docs description: Review and improve tldraw SDK documentation against the voice and docs guides, scoring each article and iterating until it passes. Use when asked to review docs, audit an article in apps/docs/content, check whether documentation follows the style guide, or improve existing documentation. --- # Review documentation This skill runs an evaluation and improvement loop on a documentation file. **Target**: $ARGUMENTS **Relevant skills**: `write-docs` ## Workflow overview ``` ┌──────────────────────────────────────────────────────────────┐ │ INITIALIZE: Create state file to track issues │ └──────────────────────────────────────────────────────────────┘ ↓ ┌──────────────────────────────────────────────────────────────┐ │ EVALUATE (parallel) │ │ ┌─────────────────────┐ ┌─────────────────────────────┐ │ │ │ Style Agent │ │ Content Agent │ │ │ │ (readability+voice) │ │ (completeness+accuracy) │ │ │ └─────────────────────┘ └─────────────────────────────┘ │ └──────────────────────────────────────────────────────────────┘ ↓ ┌──────────────────────────────────────────────────────────────┐ │ UPDATE STATE: Add new issues, verify fixed issues │ └──────────────────────────────────────────────────────────────┘ ↓ ┌──────────────────────────────────────────────────────────────┐ │ SUMMARIZE: Present findings, ask user for next step │ └──────────────────────────────────────────────────────────────┘ ↓ ┌──────────────────┼──────────────────┐ ↓ ↓ ↓ [User: improve] [User: complete] [User: done] ↓ ↓ ↓ ┌──────────────────┐ ┌──────────────────┐ EXIT │ IMPROVE │ │ COMPLETE │ │ (fix issues) │ │ (fix all, exit) │ └──────────────────┘ └──────────────────┘ ↓ ↓ LOOP → EVALUATE EXIT ``` ## State file Create a state file in the scratchpad directory to track all issues across rounds. This prevents re-discovering the same issues and allows verification of fixes. **Path**: `/review-.md` **Format**: ```markdown # Review tracker: [filename] ## Issue tracker Status values: `pending` | `fixed` | `verified-fixed` | `not-fixed` | `wont-fix` | ID | Issue | Type | Status | Round | Notes | | --- | ------------- | --------------------------- | -------------- | ----- | ---------------- | | 1 | [description] | Style/Accuracy/Completeness | pending | 1 | [details] | | 2 | [description] | Accuracy | verified-fixed | 1 | Fixed in round 1 | | 3 | [description] | Completeness | wont-fix | 2 | Out of scope | ## Round history ### Round 1 - Style: X/10, Voice: X/10, Completeness: X/10, Accuracy: X/10 - **Total: X/40** ``` **Status definitions**: - `pending`: Issue discovered, not yet addressed - `fixed`: Improvement agent claims to have fixed it, needs verification - `verified-fixed`: Evaluation confirmed the fix was applied correctly - `not-fixed`: Evaluation found the fix wasn't applied correctly - `wont-fix`: False alarm, out of scope, or intentional (e.g., completeness issues that require documentation expansion) ## Step 1: Initial evaluation For the **first round**, launch two subagents **in parallel** using the Task tool: ``` // Single message with two Task tool calls: Task(subagent_type="general-purpose", model="opus", prompt="Style evaluation...") Task(subagent_type="general-purpose", model="opus", prompt="Content evaluation...") ``` ### Style agent prompt (round 1) ``` Evaluate documentation style for: $ARGUMENTS Read the shared guides relative to this skill directory, then read the target document: 1. `../../VOICE.md` 2. `../shared/docs-guide.md` 3. $ARGUMENTS Score these dimensions (0-10): READABILITY - How clear and easy to understand is the writing? - Clear, direct sentences - Logical flow between sections - Appropriate use of code snippets and links - No unnecessary jargon VOICE - How well does it follow the writing guide? - Confident assertions (no hedging) - Active voice, present tense - No AI writing tells (hollow importance, trailing gerunds, formulaic transitions) - Appropriate tone (expert-to-developer) - Sentence case headings Important! Include as many high-priority fixes as needed. Return in this exact format: STYLE REPORT: [filename] READABILITY: [score]/10 - [specific issue or strength] - [specific issue or strength] VOICE: [score]/10 - [specific issue or strength] - [specific issue or strength] PRIORITY FIXES: 1. [Most important style issue] 2. [Second most important] 3. [Third most important] 4. ... ``` ### Content agent prompt (round 1) ``` Evaluate documentation content for: $ARGUMENTS Read $ARGUMENTS, then verify claims against the source code in packages/editor/ and packages/tldraw/. Score these dimensions (0-10): COMPLETENESS - How thorough is the coverage? - Overview establishes purpose before mechanism - Key concepts explained with enough depth - Illustrative code snippets where needed - Links to relevant examples in apps/examples (if applicable) ACCURACY - Is the technical content correct? - Code snippets are syntactically correct and use valid APIs - API references match actual implementation - Described behavior matches the code - No outdated information For accuracy issues, include file:line references to the source code. Important! Include as many high-priority fixes as needed. Make sure that all accuracy issues are flagged. Return in this exact format: CONTENT REPORT: [filename] COMPLETENESS: [score]/10 - [specific issue or strength] - [specific issue or strength] ACCURACY: [score]/10 - [specific issue with file:line reference if inaccurate] - [specific issue or strength] PRIORITY FIXES: 1. [Most important content issue] 2. [Second most important] 3. [Third most important] 4. ... ``` After round 1, **create the state file** with all discovered issues. ## Step 2: Summarize and prompt user After both agents return, synthesize their reports into a summary: ```markdown ## Evaluation: [filename] | Dimension | Score | Key issue | | ------------ | ----- | ----------- | | Readability | X/10 | [one-liner] | | Voice | X/10 | [one-liner] | | Completeness | X/10 | [one-liner] | | Accuracy | X/10 | [one-liner] | | **Total** | X/40 | | ### Priority fixes 1. [Combined priority 1 from both reports] 2. [Combined priority 2] 3. [Combined priority 3] 4. [Combined priority 4] 5. [Combined priority 5] 6. ... ``` Then ask the user using AskUserQuestion: - **Improve**: Make improvements based on findings, then re-evaluate - **Complete and finish**: Fix all remaining issues and exit (no re-evaluation) - **Done**: Exit the loop without making changes ## Step 3: Triage (before improvement) Before running the improvement agent, review the pending issues with the user. Mark completeness issues that require adding new sections as `wont-fix` - these are documentation expansion, not review fixes. Per `AGENTS.md` guidance: > "Do what has been asked; nothing more, nothing less." > "Don't add features, refactor code, or make 'improvements' beyond what was asked." The review skill improves existing content. Adding new sections is a separate task. ## Step 4: Improve Launch a single improvement agent targeting **only pending issues**: ``` Task(subagent_type="general-purpose", model="opus", prompt="Improve documentation...") ``` ### Improvement agent prompt ``` Improve documentation based on specific tracked issues: $ARGUMENTS Fix ONLY these pending issues: | ID | Issue | Type | Notes | |----|-------|------|-------| [paste pending issues from state file] Instructions: 1. Read `../../VOICE.md` and `../shared/docs-guide.md` relative to this skill directory 2. Read $ARGUMENTS 3. For each accuracy fix: - Read the source file referenced in the notes - Verify the correct API/behavior from the source - Apply the fix based on what the source code actually shows 5. Apply style fixes 6. Run prettier: yarn prettier --write $ARGUMENTS DO NOT: - Add new sections - Expand the document - Fix issues not in the list above Return a summary: CHANGES MADE: | ID | Fix applied | Verification | |----|-------------|--------------| | X | [description] | [source file:line checked] | | Y | [description] | n/a | ``` After improvement, update the state file to mark issues as `fixed`. ## Step 4b: Complete and finish (alternative to Step 4) If the user selects "Complete and finish", fix all remaining pending issues **without re-evaluating**. This is useful when the evaluation is satisfactory and the user wants to apply fixes and move on. **Workflow**: 1. Run triage (same as Step 3) to mark out-of-scope items as `wont-fix` 2. Launch the improvement agent (same prompt as Step 4) 3. Update state file to mark issues as `fixed` 4. **Exit the loop** - do not re-evaluate This path trusts the improvement agent to apply fixes correctly and skips the verification cycle. Use when: - The issues are straightforward style fixes - Time is limited and re-evaluation isn't worth the cost - Scores are already acceptable and only minor polish remains ## Step 5: Verification evaluation For **subsequent rounds**, evaluation agents verify fixes AND find new issues: ### Style agent prompt (verification) ``` Verify fixes and evaluate documentation: $ARGUMENTS Read the state file first: [path to state file] Then read the shared guides relative to this skill directory and the target document: 1. `../../VOICE.md` 2. `../shared/docs-guide.md` 3. $ARGUMENTS Your job: 1. VERIFY fixes marked as "fixed" in the state file - confirm they were actually applied 2. Score style dimensions (do NOT re-flag wont-fix issues) 3. Flag only NEW issues not already in the state file VERIFY THESE FIXES: [paste fixed style issues from state file] Return in this format: VERIFICATION REPORT: | ID | Status | Notes | |----|--------|-------| | X | verified-fixed / not-fixed | [what you found] | STYLE SCORES: READABILITY: [score]/10 VOICE: [score]/10 NEW ISSUES (not already in state file): - [issue] or "None found" ``` ### Content agent prompt (verification) ``` Verify fixes and evaluate documentation content: $ARGUMENTS Read the state file first: [path to state file] Then read $ARGUMENTS and verify claims against source code in packages/tldraw/. Your job: 1. VERIFY accuracy fixes marked as "fixed" in the state file 2. Score content dimensions (do NOT re-flag wont-fix issues) 3. Flag only NEW accuracy issues not already in the state file VERIFY THESE FIXES: [paste fixed accuracy issues from state file] Return in this format: VERIFICATION REPORT: | ID | Status | Notes | |----|--------|-------| | X | verified-fixed / not-fixed | [what you found in doc AND source] | CONTENT SCORES: COMPLETENESS: [score]/10 (score existing content only, ignore wont-fix items) ACCURACY: [score]/10 NEW ACCURACY ISSUES (not already in state file): - [issue with source file:line] or "None found" ``` After verification, update the state file with new statuses and any new issues. ## Step 6: Loop Continue the loop until: - User chooses "Done" (exit without changes) - User chooses "Complete and finish" (apply fixes, then exit) - Scores reach acceptable levels (32/40 or higher) - All issues are `verified-fixed` or `wont-fix` ## Notes - The state file prevents re-discovering the same issues across rounds - Evaluation agents verify previous fixes before scoring - `wont-fix` is appropriate for completeness issues requiring new sections - **Accuracy verification is critical**: The improvement agent must read actual source code before applying any accuracy fix - Style and content evaluations always run in parallel for efficiency

相关技能

文档办公

Ontology

为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…

文档办公

Nano Pdf

使用纳米-pdf CLI编辑带有自然语言指令的PDF.

文档办公

Word / DOCX

创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…

文档办公

Api Gateway

通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…