Token导航 LogoToken导航TokenDH.com
研究检索需要联网github未标认证来源可访问许可证需确认审计通过

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

Agent Skill

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

总安装

416

周安装

17

GitHub Stars

7

下载量

135
CodexClaudeCursorGemini CLI

安装说明

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

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 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

简介

assess-docs-code-alignment 检测代码变更是否同步更新了对应文档,输出缺失或未覆盖的补档清单。

  • 适用场景为 PR 合并前的文档门禁检查、发版前的代码回查以及持续集成中的对齐验证。
  • 核心能力包括从 diff 推断文档映射关系,标记 missing/partial/covered 状态并给出可执行建议。
  • 使用方式基于 specs/artifact-contract.md 中 code-doc-alignment 声明读取治理路径,默认写入 docs/calibration/code-doc-alignment.md。
  • 安装前需确认项目是否已定义相关 artifact type 规范,否则可能跳过评估流程导致结果不完整。

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

适合场景

01

用户想查找某类 Agent Skill 时

02

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

03

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

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

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

能力 4

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

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

平台分布

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