Token导航 LogoToken导航TokenDH.com
研究检索操作浏览器github未标认证来源可访问许可证需确认审计通过

design-doc-reviewer设计文档审阅者

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

1

周安装

12

GitHub Stars

公开资料未说明

下载量

97
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:design-doc-reviewer(设计文档审阅者)
来源仓库:https://github.com/eho/agent-skills
仓库路径:skills/design-doc-reviewer
安装命令:
npx skills add https://github.com/eho/agent-skills --skill design-doc-reviewer
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/eho/agent-skills --skill design-doc-reviewer

简介

用于对设计文档进行结构化评审,输出具体、可操作的意见反馈。

  • 适合检查文档完整性、术语一致性及与产品愿景的对齐情况。
  • 基于质量清单逐项评估,确保评审结果直接关联文档内容而非泛泛而谈。
  • 需结合项目上下文判断,不擅自修改文档内容或添加未经验证的建议。
  • design-doc-reviewer 属于研究检索类 Skill,可作为该场景下的辅助能力补充。

SKILL.md

Design Doc Reviewer

Produce structured, actionable review feedback on a design document. Reviews should be specific — not generic praise or criticism — and directly tied to content in the doc.


The Job

  1. Identify which document to review (from the user's message, or ask)
  2. Read the design doc in full
  3. Read the vision doc (docs/vision/vision.md) for product alignment context
  4. Evaluate the doc against the quality rubric below
  5. Output the review in the structured format below

Step 1: Locate the Document

If the user didn't specify a path, check docs/design/ for recent files. Ask if ambiguous. Read the doc fully before evaluating.

Also read (if they exist):

  • docs/vision/vision.md or equivalent product vision doc — to check product alignment
  • Any directly related existing designs or architecture docs if referenced

Step 2: Evaluate Against the Rubric

Score each element as: ✅ Present & Strong / ⚠️ Partial or Unclear / ❌ Missing

Required Elements

#ElementWhat to look for
1Problem StatementConcrete pain or gap — not "we want to add X." Should answer: what breaks today without this?
2GoalsNumbered, specific, and measurable. Can you tell when a goal is met?
3Success MetricsHow will success be measured post-implementation? Quantifiable where possible (latency, error rate, adoption).
4Non-GoalsExplicit list of what's out of scope and why. Missing = the doc hasn't thought about scope.
5Alternatives ConsideredAt least 2 alternative approaches with rationale for rejection. Missing = the chosen approach feels arbitrary.
6Design PrinciplesNamed principles (not just description of approach). Serve as tie-breakers for ambiguous choices.
7Vision AlignmentIf a vision doc exists: does the design explicitly connect its choices to the product vision? Does it justify any tension? Not just "this aligns" — it should name specific vision goals it advances. Omitted is fine only if no vision doc exists.
8Architecture OverviewDiagram or component list. Reader should understand the system model without reading all prose.
9API & Data ContractsExact interfaces, schemas, or payloads — not just descriptions. What gets stored, where, in what format. Strict enough for an implementer to code against.
10Integration PointsWhich existing files, APIs, events, or hooks are modified. Specific — file names and function names.
11Sequence / Flow WalkthroughStep-by-step for the critical path. ASCII diagram or numbered sequence for complex async flows.
12Example OutputWhat does the user actually see? JSON response, CLI output, UI state, or file content example.
13ConfigurationEnv vars, feature flags, or tunables — with defaults, types, and descriptions.
14Testing StrategyNot just "we'll write unit tests." Names specific test cases, edge cases, and integration scenarios.
15Edge Cases & FailuresWhat can go wrong? For each failure mode: how is it detected, and what's the mitigation?
16RisksKnown technical or product risks, with likelihood, impact, and mitigation plan for each.
17Open QuestionsDoes the doc itself include an explicit list of unresolved decisions or unknowns? Their presence signals intellectual honesty; their absence may mean the author hasn't surfaced real uncertainty.
18Context Required for ImplementationDoes the doc list exact file paths an implementer must read before starting? Missing = the implementer has to rediscover context.
19User StoriesAre there well-formed user stories with acceptance criteria? See User Story Quality below.
20Future ExtensionsIdeas deferred with rationale. Shows the design is part of a roadmap, not a closed system.

Quality Signals (score holistically)

  • Principle-driven consistency: Do implementation choices trace back to stated principles? Or do choices feel arbitrary?
  • State ownership clarity: For every piece of mutable state, is it clear who creates/reads/modifies it?
  • Decision rationale: For significant architectural choices, does the doc answer "why not the alternative"?
  • Concrete over abstract: Does the doc use real examples (JSON, file paths, code, CLI output) or only prose?
  • Failure path coverage: Does the doc only describe the happy path, or does it address what happens when things go wrong?
  • Product alignment: Does the Vision Alignment section make a substantive argument, or is it hand-waving? Does it name specific vision goals?
  • Scope discipline: Is the design appropriately scoped, or is it trying to solve everything at once?

User Story Quality (evaluate each story)

Apply the Agent-Ready Test to every user story: could an AI agent implement this story without asking for more information? If "No" or "Maybe," the story needs more detail.

  • Self-contained: Does each story include enough context (file paths, data contracts, relevant interfaces) that an agent doesn't need to read the full design doc?
  • Acceptance criteria are binary: Every criterion must be verifiable — "works correctly" fails, "returns 404 when user ID doesn't exist" passes.
  • Testing requirements present: Every story must have explicit testing AC (unit tests for logic, browser verification for UI). No exceptions.
  • Documentation requirements present: Stories that add user-facing functionality, CLI flags, API endpoints, or architectural changes must include AC to update the specific doc file. "Update docs if applicable" is not acceptable — the file must be named.
  • Granularity: Stories should be minimized in count but each small enough for an agent to complete in one focused session. Not over-fragmented, not combining unrelated tasks.
  • Grounded in design: Do stories reference exact file paths, function names, and data contracts from the design sections? Or are they disconnected from the technical work above?

Step 3: Output the Review

Use this exact structure:


Design Doc Review: [Document Title]

File: docs/design/[filename].md Reviewed: [today's date] Overall Assessment: [1–2 sentences. What's the doc's current state? Is it ready to implement, needs revision, or needs substantial work?]


Scorecard

ElementStatusNotes
Problem Statement✅/⚠️/❌[specific observation]
Goals✅/⚠️/❌[specific observation]
Success Metrics✅/⚠️/❌[specific observation]
Non-Goals✅/⚠️/❌[specific observation]
Alternatives Considered✅/⚠️/❌[specific observation]
Design Principles✅/⚠️/❌[specific observation]
Vision Alignment✅/⚠️/❌[specific observation]
Architecture Overview✅/⚠️/❌[specific observation]
API & Data Contracts✅/⚠️/❌[specific observation]
Integration Points✅/⚠️/❌[specific observation]
Sequence / Flow✅/⚠️/❌[specific observation]
Example Output✅/⚠️/❌[specific observation]
Configuration✅/⚠️/❌[specific observation]
Testing Strategy✅/⚠️/❌[specific observation]
Observability & Logging✅/⚠️/❌[specific observation]
Edge Cases & Failures✅/⚠️/❌[specific observation]
Risks✅/⚠️/❌[specific observation]
Open Questions✅/⚠️/❌[specific observation]
Context Required for Implementation✅/⚠️/❌[specific observation]
User Stories✅/⚠️/❌[specific observation]
Future Extensions✅/⚠️/❌[specific observation]

Score: X/21 elements present and strong


Strengths

List 2–4 specific strengths. Reference actual content from the doc (quote sections, describe specific design decisions). Don't be generic.

  • [Strength title]: [specific observation with reference to doc content]

Critical Gaps (must fix before implementation)

Issues that could cause implementation problems, ambiguity, or rework. Be specific about what's missing and what the impact is.

  • [Gap title]: [what's missing, why it matters, and a concrete suggestion for how to address it]

Minor Issues (should fix, but not blocking)

  • [Issue title]: [what's unclear or incomplete, and how to improve it]

Additional Open Questions

Questions the doc hasn't answered that an implementer would need to resolve — beyond any already listed in the doc itself:

  1. [Question]
  2. [Question]

Recommended Next Steps

Prioritized list of what the author should do before this doc is ready to implement:

  1. [Highest priority action]
  2. [Next action]
  3. ...

Output

Save the review as docs/design/review-[original-filename].md (e.g., reviewing docs/design/auth-redesign.md → save to docs/design/review-auth-redesign.md). Then tell the user the file was saved and summarize the score and top 2–3 critical gaps in a short message.


Review Principles

  • Be specific, not generic. "The testing strategy is weak" is not useful. "The testing strategy lists unit tests but doesn't name a single test case or edge case" is useful.
  • Quote the doc. Reference actual sections, headings, or excerpts. This proves you read it and helps the author find exactly what to fix.
  • Separate blockers from polish. Critical gaps block implementation. Minor issues are improvements. Don't conflate them.
  • Acknowledge what's strong. A good review isn't only criticism. Noting what works well is as important as noting what doesn't — it tells the author what not to change.
  • Propose, don't just critique. For every gap, suggest what's needed. "Add an edge cases table covering: DB lock failure, OS permission denial, and partial write crash" is more useful than "edge cases are missing."
  • Respect scope. Don't ask the doc to solve everything. If something is intentionally deferred, acknowledge it — don't flag it as a gap.

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

35.45%
按下载量换算34

Claude

28.79%
按下载量换算28

Cursor

19.69%
按下载量换算19

Gemini CLI

9.5%
按下载量换算9

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

操作浏览器

该 Skill 可能涉及浏览器控制能力,使用时可能读取或操作网页内容,需要在受控环境中确认权限边界。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills