关于 engram-docs-alignment
engram-docs-alignment 是一项用于让项目文档与已实现行为保持一致的技能，指导贡献者随代码变更同步更新并验证文档。
主要功能
- 01描述当前实际行为
- 02随代码变更更新文档
- 03发布前验证示例
- 04核对路由、路径和命令
适用场景
- 01变更 API 或设置流程
- 02更新 CLI 命令和示例
- 03编写贡献者指南
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/engram-docs-alignment确认已加载。
详细介绍
适用场景
在以下情况下使用此技能：
- 更改 API、设置流程或插件行为
- 更新 CLI 命令或示例
- 编写贡献者指南
对齐规则
- 文档必须描述当前行为，而非预期行为。
- 在同一个 PR 中随代码变更一并更新文档。
- 发布前验证示例。
- 删除对已弃用文件、端点或脚本的引用。
验证
- 端点名称与服务端路由一致
- 脚本名称与仓库路径一致
- 命令示例可按文档所述执行
- 跨 Agent 说明仍然准确
评论
支持 Markdown