Token导航 LogoToken导航

Agent Skill · 研究检索

assess-docs-code-alignment(评估文档代码对齐)

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

assess-docs-code-alignment 是研究检索类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为需要联网;许可证信息还不明确,第三方扫描已通过,按安装量在研究检索类的 73,675 个 Skill 里排第 58,406。

总安装 416周安装 17GitHub Stars 7下载 135核验 2026-05-01

安装说明

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

安装方式

通过对话安装

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

请帮我安装这个 Agent Skill:assess-docs-code-alignment(评估文档代码对齐)
来源仓库:https://github.com/nesnilnehc/ai-cortex
仓库路径:skills/assess-docs-code-alignment
安装命令:
npx skills add https://github.com/nesnilnehc/ai-cortex --skill assess-docs-code-alignment
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/nesnilnehc/ai-cortex --skill assess-docs-code-alignment

这个 Skill 是做什么的

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

assess-docs-code-alignment 检测代码变更是否同步更新了对应文档,输出缺失或未覆盖的补档清单。适用场景为 PR 合并前的文档门禁检查、发版前的代码回查以及持续集成中的对齐验证。核心能力包括从 diff 推断文档映射关系,标记 missing/partial/covered 状态并给出可执行建议。

使用方式基于 specs/artifact-contract.md 中 code-doc-alignment 声明读取治理路径,默认写入 docs/calibration/code-doc-alignment.md。安装前需确认项目是否已定义相关 artifact type 规范,否则可能跳过评估流程导致结果不完整。

来源仓库内路径:skills/assess-docs-code-alignment

上手步骤

4 步
  1. 1

    确认自己的宿主工具

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

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/nesnilnehc/ai-cortex --skill assess-docs-code-…;命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

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

  4. 4

    按最小权限试用

    它需要需要联网,先在测试目录或测试账号里跑,确认没问题再放到正式项目。

常见问题

6 条

assess-docs-code-alignment 怎么安装?

在终端执行 npx skills add https://github.com/nesnilnehc/ai-cortex --skill assess-docs-code-alignment。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

assess-docs-code-alignment 支持哪些 AI 工具?

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

assess-docs-code-alignment 需要什么权限?

权限级别是需要联网。该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

assess-docs-code-alignment 是免费的吗?

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

assess-docs-code-alignment 用的人多吗?

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

assess-docs-code-alignment 安全吗?

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

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

值得选的地方

  • 同时适配 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调用外部服务未明确有提醒
assess-docs-code-alignment

评估文档代码对齐 · 本页

4167需要联网未明确通过

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

SKILL.md 原文

技能:代码文档对齐评估(Assess Docs Code Alignment)

目的 (Purpose)

检测代码改动是否有相应文档更新,输出可执行的补文档清单。


核心目标(Core Objective)

首要目标:从代码 diff 推断需要更新的文档,并报告未覆盖缺口。

成功标准:

  1. ✅ 已解析代码 diff 范围
  2. ✅ 已映射代码区域到文档区域
  3. ✅ 已输出 missing/partial/covered 对齐结果
  4. ✅ 已产出可执行补齐建议
  5. ✅ 已写入 docs/calibration/code-doc-alignment.md

范围边界(Scope Boundaries)

本技能负责:代码变更与文档变更对齐分析。 本技能不负责:文档规范评估(assess-docs)、链接图(assess-docs-links)、SSOT(assess-docs-ssot)。


使用场景(Use Cases)

  • PR 合并前文档门禁
  • 发版前代码变更回查

行为(Behavior)

阶段 0:Norms Resolution(v1.1 新增)

按 specs/artifact-contract.md §8 Runtime Norms Resolution Protocol 的 §8.2 / §8.3 / §8.5 实现:读项目规范若声明了 code-doc-alignment artifact_type 的 path_pattern,则使用项目值;否则 fall through 到技能默认(docs/calibration/code-doc-alignment.md)。本技能为固定路径治理产出,只用 path_pattern 覆盖机制。

阶段 1:代码-文档对齐评估

  1. 获取 diff:git diff <base>...HEAD --name-status --diff-filter=MAD
  2. 归类代码变更区域
  3. 依据映射规则推断“应更新文档”
  4. 对比当前分支文档改动
  5. 输出 findings 与建议

输入与输出 (Input & Output)

输入

  • base 或 diff 范围
  • docs 根路径(可选)
  • 区域映射规则(可选)

输出

  • docs/calibration/code-doc-alignment.md

限制(Restrictions)

  • 不修改代码与文档文件
  • 仅输出评估和建议

自检(Self-Check)

  • 已解析 diff
  • 已产出缺口列表与建议
  • 已写入单一对齐报告

示例(Examples)

  • src/api/auth.py 修改但 docs/architecture/api.md 未更新 -> high

平台分布

Codex

37.42%
按下载量换算51

Claude

26.9%
按下载量换算36

Cursor

18.1%
按下载量换算24

Gemini CLI

10.28%
按下载量换算14

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

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

继续浏览同类 Skills