Token导航 LogoToken导航

Agent Skill · 研究检索

doc-adr-audit(ADR 审核文件)

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

doc-adr-audit 是研究检索类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为只读;许可证信息还不明确,第三方扫描已通过,按安装量在研究检索类的 73,675 个 Skill 里排第 72,323。

总安装 188周安装 8GitHub Stars 14下载 66核验 2026-05-01

安装说明

本站只整理中文说明,不托管安装包,也不代用户安装。
GitHub
许可证
unknown

安装方式

通过对话安装

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

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

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-adr-audit

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题,通常会让助手先检索再总结。

用于对架构决策记录(ADR)执行结构校验与语义审查,生成综合审计报告。适用于验证 ADR 文件的结构合规性与内容质量,支持迭代修复流程。通过单一命令触发审计流程,输出报告供后续修复工具使用。需配合 aidoc-flow-framework 仓库安装,仅支持指定宿主环境调用。

doc-adr-audit 属于研究检索类 Skill,可作为该场景下的辅助能力补充。

来源仓库内路径:skills/doc-adr-audit

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI;先确认自己用的是其中之一,再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-adr…;命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开,让新装的 Skill 被重新扫描到,否则列表里可能看不到。

  4. 4

    按最小权限试用

    它标注为只读,先用只读任务试一次,确认行为符合预期再扩大使用范围。

常见问题

6 条

doc-adr-audit 怎么安装?

在终端执行 npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-adr-audit。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

doc-adr-audit 支持哪些 AI 工具?

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录,一般也能手动放进去,但要自己确认触发方式是否一致。

doc-adr-audit 需要什么权限?

权限级别是只读。该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

doc-adr-audit 是免费的吗?

公开资料没有标注明确许可证,收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

doc-adr-audit 用的人多吗?

公开数据是累计安装 188 次,近一周安装 8 次,下载 66 次,GitHub 14 星。这些数字来自第三方目录统计,只能当作热度参考,不代表质量或安全性。

doc-adr-audit 安全吗?

第三方扫描结果为通过,但这只覆盖已知的静态检查项,不能替代自己读一遍源码和安装命令。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具,换客户端不用重新找替代品。
  • 第三方扫描已通过,常见的高风险行为没有命中。
  • 标注为只读权限,试用阶段不容易误改本地文件。

先想清楚的地方

  • 许可证没有明确标注,能不能商用、能不能再分发都不确定。
  • 第三方目录整理,版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex,想直接扩展它能力的人。
  • 需要处理研究检索类任务、又不想每次都手写提示词的人。
  • 只想先试试效果、不希望它改动本地文件的人。

不太适合

  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
find-skills

寻找技能 · Codex、Claude

31,199,81316,486操作浏览器MIT有提醒
self-improving-agent

自我改进 Agent · OpenClaw

16,464,0023,396接触敏感数据MIT-0通过
soultrace

灵魂追踪 · Codex、Claude

7,588,94412需要联网未明确有提醒
self-improving

自我完善 · OpenClaw

6,829,2841,046需要联网MIT-0通过
microsoft-foundry

微软代工厂 · Codex、Claude

6,614,144764调用外部服务未明确有提醒
doc-adr-audit

ADR 审核文件 · 本页

18814只读未明确通过

按安装量取同分类前几名;数字来自第三方目录统计,只作热度参考,不代表质量结论。

SKILL.md 原文

doc-adr-audit

Purpose

Run a single ADR audit workflow that executes:

  1. doc-adr-validator (structural/schema gate)
  2. doc-adr-reviewer (semantic/content quality gate)

Then emit one combined report optimized for doc-adr-fixer input.

Layer: 5 (ADR Quality Gate Wrapper)

Upstream: ADR file(s)

Downstream:

  • Combined Audit Report: ADR-NN.A_audit_report_vNNN.md
  • Optional Fix Cycle trigger for doc-adr-fixer

Why This Skill Exists

Use this wrapper to avoid user confusion between validator and reviewer while preserving separation of concerns.

ConcernOwner Skill
Schema/template compliancedoc-adr-validator
Content quality and decision completenessdoc-adr-reviewer
Single user-facing audit commanddoc-adr-audit

When to Use

Use doc-adr-audit when:

  • You want one command for ADR quality checks
  • You need a combined report for doc-adr-fixer
  • You are running QA before SYS generation

Do NOT use when:

  • ADR does not exist (use doc-adr / doc-adr-autopilot generation first)
  • You only need one specific check domain (use validator or reviewer directly)

Execution Contract

Input

  • ADR path (docs/05_ADR/ADR-NN_*/...)
  • Optional: threshold (default review threshold: 90)

Sequence (Mandatory)

1) Run doc-adr-validator
2) Run doc-adr-reviewer
3) Normalize and merge findings
4) Write ADR-NN.A_audit_report_vNNN.md
5) If auto-fixable findings exist, hand off to doc-adr-fixer

Combined Status Rules

  • PASS: Validator PASS AND Reviewer score >= threshold AND no blocking issues
  • FAIL: Validator FAIL OR Reviewer score < threshold OR blocking/manual-required issues present

Combined Report Format (for doc-adr-fixer)

Output file: ADR-NN.A_audit_report_vNNN.md

Required sections:

  1. ## Summary

- ADR ID, timestamp (EST), overall status - Validator status, reviewer score

  1. ## Score Calculation (Deduction-Based)

- Formula: 100 - total_deductions - Threshold comparison (>=90 pass gate)

  1. ## Validator Findings

- List by severity/code

  1. ## Reviewer Findings

- List by severity/code

  1. ## Coverage Findings

- Decision completeness summary - Architecture flow/diagram coverage summary - Traceability/tag coverage summary

  1. ## Fix Queue for doc-adr-fixer

- auto_fixable - manual_required - blocked

  1. ## Recommended Next Step

- run doc-adr-fixer - or manual update required

Fix Queue Normalization

Each finding MUST include:

  • source: validator | reviewer
  • code: issue code
  • severity: error|warning|info
  • file: relative path
  • section: heading/anchor if known
  • action_hint: short imperative guidance
  • confidence: high|medium|manual-required

Hand-off Contract to doc-adr-fixer

doc-adr-fixer MUST accept combined audit report as equivalent upstream input:

  • ADR-NN.A_audit_report_vNNN.md (preferred)
  • ADR-NN.R_review_report_vNNN.md (legacy compatibility)

Precedence rule:

  1. Select newest timestamp.
  2. If timestamps are equal, prefer .A_audit_report over .R_review_report.

Example Invocation

/doc-adr-audit docs/05_ADR/ADR-01_f1_iam/

Expected outcome:

  1. validator runs
  2. reviewer runs
  3. combined audit report generated
  4. fixer can execute directly from combined report

Version History

VersionDateChanges
1.02026-02-27Initial ADR audit wrapper; validator→reviewer orchestration; combined report contract for fixer with .A_ preferred and .R_ legacy compatibility

Implementation Plan Consistency (IPLAN-004)

  • Treat plan-derived outputs as valid source mode and verify intent preservation from implementation plan scope/objectives.
  • Validate upstream autopilot precedence assumption: --iplan > --ref > --prompt.
  • Flag objective/scope conflicts between plan context and artifact output as blocking issues requiring clarification.
  • Do not introduce legacy fallback paths such as docs-v2.0/00_REF.

平台分布

Codex

34.05%
按下载量换算22

Claude

30.4%
按下载量换算20

Cursor

19.37%
按下载量换算13

Gemini CLI

8.99%
按下载量换算6

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

只读

该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

安装前确认

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

继续浏览同类 Skills