前置条件
- 已安装 Node.js 18+
- 拥有 Claude 订阅(Pro / Max / API)
安装与启动
在 NEC 文档中的典型用法
1
进入 docs 目录
2
让 Claude 读取项目规范
首次使用时,建议提示 Claude 先阅读项目根目录的
AGENTS.md,了解 NEC 文档的文件规范、导航结构与内容边界。3
执行文档维护任务
示例指令:
- “检查所有 mdx 文件是否都有 frontmatter,补充缺失的 title 和 description”
- “把 docs.json 中未注册的孤立页面列出来”
- “批量修复 community/team.mdx 中的 badge 颜色拼写错误”
常用技巧
- 批量替换:用自然语言描述替换规则,Claude 会自动扫描多文件并确认。
- JSON 校验:让 Claude 在修改
docs.json后自动运行 JSON 校验。 - 保持简洁:给 Claude 的指令尽量具体,例如”只改拼写,不调整结构”。