关于 w-docs
w-docs 是用于随代码变更更新文档的仓库技能,帮助 Agent 选择合适的现有文档层,避免重复维护项目信息。
主要功能
- 01选择匹配的文档章节
- 02更新权威 MDX 主题页
- 03README 仅记录设置与运行信息
- 04仅在约束变化时更新 Agent 规则
- 05不擅自移动文件或提交
适用场景
- 01记录行为或架构变更
- 02脚本变更后更新设置说明
- 03整理文档文件移动方案
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ blockmatic/ basilic-skills --skill w-docs安装后在 Claude Code 中输入/w-docs确认已加载。
详细介绍
记录当前代码或功能。遵循使用方仓库的文档和 README 规则。除非收到要求,否则不要提交。持久的信息架构应归入现有 MDX;不要另行创建站点地图。
将内容写入负责该变更的层:
| 层 | 职责 | 在何时更新 |
|---|---|---|
技术文档(AGENTS.md 中的路径) | 架构、ADR、操作指南 | 行为、架构、命令、约定或工作流发生变化时 |
| Agent 规则 | 简短约束 | Agent 不得违反的约定发生变化时 |
| 最近的 README | 如何运行此应用/包;仅放链接 | 脚本、设置或包用途发生变化时 |
仅在代码容易引起误解时添加内联注释。不要将 MDX 复制到规则或 README 中。不要用 @ 链接 MDX。
- 确认匹配的文档章节,然后找到现有主题页面(仅在没有合适页面时才新建页面)。
- 如果规范说明发生变化,编写或修改 MDX。
- 仅在运行/设置/脚本发生变化时修改 README;添加指向 MDX 的链接。
- 仅在约束发生变化时修改 glob 匹配的规则。
- 对机械性的文件或文档移动:按相关文件分组,提出最精简的起始路径/目标路径清单;省略分组内的文件夹名称前缀。仅在用户提供路径时保存。除非用户也要求实施,否则不要移动文件。
评论
支持 Markdown