跳到主内容
智客 ZICQ

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

Review Docs

立即审查 README 或一个从几个真正的读者点看的文件页。 粉丝们为每个观众出出一个平行的评审员——克洛德码新人,电力用户,插件/技能作者,怀疑的资深工程师,非运行的决策者——每个评分为x/5并命名了混凝土,行平面修饰. 当被请求审查,批评,分级,或"Get to N/5" README 或任何前门 doc,或检查doc如何为真正的用户读取. 不用于代码审查(为此使用/代码审查).

599 安装量

官方网址:skills.sh

技能介绍

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

做什么

立即审查 README 或一个从几个真正的读者点看的文件页。 粉丝为每个观众出出一个平行的审查员——克洛德码新人,电力用户,插件/技能作者,怀疑的资深工程师,非运行的决策者——每个评分x/5,并命名混凝土,线级修正

何时用

要求审查,批评,分级,或"Get to N/5" README 或任何前门 Doc,或检查doc如何为真正的用户读取. 不用于代码审查(使用/代码审查)

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:How to run it、1. Read the target doc yourself first、2. Fan out one subagent per persona — in parallel、3. The personas (the fan-out set)、4. Synthesize、5. Iterate to a target (only when asked)。

文件分析

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

官方 description(原文)

Review the README or a documentation page from several real reader points of view at once. Fans out one parallel reviewer per audience — Claude Code newcomer, power user, plugin/skill author, skeptical senior engineer, non-running decision-maker — each scoring it x/5 and naming concrete, line-level fixes. Use when asked to review, critique, grade, or "get to N/5" the README or any front-door doc, or to check how a doc reads for real users. Not for code review (use /code-review for that).

How to run it1. Read the target doc yourself first2. Fan out one subagent per persona — in parallel3. The personas (the fan-out set)4. Synthesize5. Iterate to a target (only when asked)Output formatDoc review — <file>ScoresCross-cutting issues (highest leverage)Per-persona highlightsRanked fixes

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
review-docs
description
Review the README or a documentation page from several real reader points of view at once. Fans out one parallel reviewer per audience — Claude Code newcomer, power user, plugin/skill author, skeptical senior engineer, non-running decision-maker — each scoring it x/5 and naming concrete, line-level fixes. Use when asked to review, critique, grade, or "get to N/5" the README or any front-door doc, or to check how a doc reads for real users. Not for code review (use /code-review for that).
  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-8ee656d5110676f5-%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/zernie/vigiles' --list

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

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

阅读排版
--- name: review-docs description: Review the README or a documentation page from several real reader points of view at once. Fans out one parallel reviewer per audience — Claude Code newcomer, power user, plugin/skill author, skeptical senior engineer, non-running decision-maker — each scoring it x/5 and naming concrete, line-level fixes. Use when asked to review, critique, grade, or "get to N/5" the README or any front-door doc, or to check how a doc reads for real users. Not for code review (use /code-review for that). --- Review a front-door doc (default `README.md`; honor a path the user names) the way real readers would — not the way the author does. The author knows what every line means; a first-time reader does not. The job is to surface where a specific audience gets confused, under-served, or bounces, score it, and propose concrete fixes. The method is **fan-out**: spawn one subagent PER PERSONA, all in parallel, each doing a cold read as that reader. Different readers catch different things; running them concurrently is faster and keeps each read uncontaminated by the others. ## How to run it ### 1. Read the target doc yourself first Read the doc in full and skim the docs it links to (so "promises depth the linked doc doesn't deliver" is checkable). You need this to judge the personas' findings and to apply fixes later. ### 2. Fan out one subagent per persona — in parallel Spawn the personas below as subagents **in a single message** (multiple Agent/Task calls at once) so they run concurrently. Use a fast, cheap model (Sonnet or Haiku) — this is a reading/judgment task, not heavy synthesis — and say so in one line when you launch them. Give EACH subagent the same rubric, only the persona changes: > You are **\**. Read `` (ignore any HTML comment block at the top — > that's internal authoring notes, not user-facing copy). Do a COLD read as this > reader: adopt their goals, vocabulary, and patience. Be a harsh grader — most > READMEs are a 3; 5/5 means you'd genuinely act on it and it's crisp end to end. > Return ONLY: > > 1. **SCORE: x/5** > 2. **30-second test:** after the first screen only, in one sentence, what do you > think this tool does — and is that right/wrong/fuzzy? > 3. **Top 3 concrete problems** — each quotes the exact line/phrase and gives a > specific suggested rewrite (confusing jargon, sentences carrying too many ideas, > anything that doesn't sell, formatting that hurts scanning, hype that costs > trust). > 4. **Jargon check:** every word you had to stop on (harness, spec, eval, subagent, > rings, recall/precision…) — is it defined in context or left guessing? > 5. **What works** — keep these, so revisions don't lose them. > 6. **The one change** that would move the score most. > Quote exact text. Be useful, not polite. ### 3. The personas (the fan-out set) Run all of these unless the user scopes to a subset. Edit the set freely for a given doc — these are the default readers of vigiles's front door. 1. **Claude Code newcomer** — new to agentic tooling, bounces on undefined terms. Needs a clear "what do I do first," not theory. Catches jargon used before it's defined. 2. **Claude Code power user** — lives in CC, skimming on a phone between tasks. Wants the WOW in the first screen and a copy-paste install in seconds; allergic to fluff. 3. **Plugin / skill author** — mid-level dev, comfortable with TS but not a rule-enforcer/types nerd. Found this because it claims to test their skills. Cares about "does it work on MY repo without learning a new theory?" 4. **Skeptical senior / staff engineer** — scans for substance in ~20s, mentally compares to promptfoo / ESLint / ast-grep. Anything hand-wavy or overclaimed costs trust; every load-bearing claim should link proof. 5. **Decision-maker (won't run a command)** — deciding whether the team adopts. Cares about cost, risk, effort; needs the "free deterministic vs. metered per-token" story and the low-risk incremental on-ramp to be legible without running anything. 6. **Codex user (optional)** — uses `AGENTS.md`, not Claude Code. Skeptical this is "a Claude-only thing." Is Codex support visible early or buried/footnoted? ### 4. Synthesize Collect the scores and reports. Then: - **Cross-cutting issues first.** The 2–4 problems that hurt MULTIPLE personas are the highest-leverage fixes — lead with those. - **Lowest score is the ceiling.** The doc is only as good as its weakest reader's read; name what's blocking that persona. - Produce a **ranked fix list** — highest reader-impact first, each a one-line action quoting the line and the fix. ### 5. Iterate to a target (only when asked) If the user asks to "get it to N/5" (or "until 5/5"): apply the highest-leverage fixes yourself, then **re-fan-out** (resume the same subagents with the change list, or spawn fresh) and collect new scores. Repeat until every persona is at the target or scores stop moving. **Bound it** — if a round produces no improvement, or after ~3 rounds, stop and report what's blocking the last point rather than churning. By default this skill REPORTS; only enter the apply-and-iterate loop on an explicit "fix it / get it to N/5". ## Output format ``` # Doc review — ## Scores — x/5 (one-line verdict each) ## Cross-cutting issues (highest leverage) The 2–4 problems hitting multiple personas, each with the line + the fix. ## Per-persona highlights The sharpest single finding from each reader (don't dump the full reports). ## Ranked fixes Ordered, highest reader-impact first — each a one-line action. ``` Keep the synthesis scannable and ACTIONABLE: every finding names a line and a fix. Hold the doc to its own standards while reviewing — for the README that's the front-door brevity bar (lead with benefits, one idea per sentence, define jargon at first use, push depth into linked docs). Don't rewrite the doc in place unless the user asks for the iterate loop — this skill REPORTS by default.

相关技能

文档办公

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,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…