关于 readme
用于将 Markdown 中的 HTML 注释视为代码事实和一致性要求的符号引用的技能。它指导扫描仓库文件，并按逻辑代码结构或路径解析引用。
主要功能
- 01识别 Markdown 符号引用注释
- 02解析路径或逻辑引用
- 03扫描未忽略的 Markdown 文件
- 04优先使用稳定的逻辑引用
适用场景
- 01使 API 文档与源码保持一致
- 02修改仓库时查找符号引用
- 03检查项目各模块的文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/readme确认已加载。
附带文件agents/openai.yaml
详细介绍
符号化 README 引用
Markdown 文件中的 HTML 注释可作为针对代码库的声明式查询，用来描述周围内容应当反映什么。例如：
## API
| Function | Description |
| --- | --- |
| `createMachine(config)` | Creates a state machine |
## Installation
`npm install xstate`
如果注释描述的内容可以从源代码推导出来——例如对文件/模块、包元数据、代码结构或一致性约束（consistent with、matching、derived from）的引用——那么它就是符号化引用。纯编辑性注释（``）不是符号化引用。
引用可以是带路径限定的（exported functions from src/index.ts），也可以是逻辑性的（all exported creator functions、public API of the state module、supported config options）。通过在代码库中搜索符合描述的结构来解析逻辑性引用——不要要求必须提供文件名。
更改代码库时
- 扫描所有未被 git 忽略的 Markdown 文件，查找符号化注释：
rg -l '或— 而不是），范围限定为一个概念，并引用逻辑结构，而不是行号。如果涉及多个文件或内容可能移动，优先使用逻辑描述。
范围
适用于项目目录树中所有未被 git 忽略的 Markdown 文件——README.md、packages/*/README.md、src/**/README.md、docs/**/*.md、CONTRIBUTING.md 等。
评论
支持 Markdown