关于 writing-rules
writing-rules 将写作规范拆分为按内容类型适用的规则文件，并在写入 Markdown 时通过 PreToolUse hook 注入匹配规则。它适用于希望在仓库中统一文档、Agent 文件及 Git 文本风格的团队。
主要功能
- 01按受众拆分规则文件
- 02写入时注入匹配规则
- 03跳过指定目录与文件
- 04检查变更文件中的 Mermaid 图
适用场景
- 01编写 README 和文档
- 02生成 Agent 指令文件
- 03检查分支变更中的 Mermaid 图
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/writing-rules确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
rules/all.mddense.mdgit.mdplain.mdscripts/check-mermaid.mjsdefault-branch.mjsinject-writing-rules.mjs详细介绍
写作规则
一份清单，一份副本，从中心同步而来——规则在此处更新，绝不在使用方更新。各仓库的执行方式可能不同，但规则始终一致。
规则存放在旁置文件中，每种风格各一份，因此只会注入适用的规则：
- rules/all.md — 适用于所有文件：受众、用词和链接、禁用清单、陈述内容的归属
- rules/plain.md — 面向人类读者：README、文档、代码注释
- rules/dense.md — 仅供 Agent 阅读：CLAUDE.md、AGENTS.md、技能文件、Agent 文档；两者都适用时，以 dense 为准
- rules/git.md — 提交、PR、问题；格式由 setup-repo 的提交门禁强制执行
要手动审阅或撰写文字内容？请阅读上面的旁置文件——本文件不包含任何规则。
写入操作时注入
scripts/inject-writing-rules.mjs 是一个 PreToolUse 钩子：每次调用文件写入工具时，它都会根据路径打印匹配的规则（all + plain|dense）作为额外上下文，让写入者无需加载此技能即可看到规则。/setup-repo 会将其接入 .claude/settings.json。仅适用于 Markdown 文件；跳过 node_modules、.temp/ 和同步的 .claude/skills/.claude/rules 目录树。
Mermaid 检查
scripts/check-mermaid.mjs 会解析分支所更改的 .md、.mdx 和 .mmd 文件中的所有 Mermaid 图表。verify 技能的 push 阶段会运行它。它需要仓库的 mermaid 和 jsdom 开发依赖；/setup-repo 会安装它们。
评论
支持 Markdown