SuperAPI AI 工具集

claude-rules-authoring

智能体与模型

查看项目

更新于 10-16 10:49

技能介绍

用途

Claude Rules Authoring 用于在 .claude/rules/ 目录中创建可复用的指令文件,用来沉淀项目约定(如格式化规范、架构模式、工作流指南、提交标准等)。它帮助区分两类内容的存放位置:一次性指令、项目特定的命令与关键文件位置应放入 CLAUDE.md;而可复用的约定、跨文件的模式应放入 rules/。

主要能力

该技能明确了规则文件与 CLAUDE.md 的差异:

方面 CLAUDE.md .claude/rules/
加载方式 会话启动时自动加载 通过引用按需加载
内容 项目设置、关键命令 可复用的约定
大小 简洁(约 200-500 行) 可以详细
范围 特定项目 跨文件的模式

它同时提供文件命名约定(全大写加 .md 扩展名、一文件一关注点、多词用 kebab-case,如 API-PATTERNS.md、CODE-REVIEW.md;推荐 FORMATTING.md、TESTING.md、COMMITS.md,避免 formatting.md、MyRules.md、everything.md)、目录结构示例(如 FORMATTING.md、TESTING.md、COMMITS.md、ARCHITECTURE.md、SECURITY.md)、内容结构建议(标题、简述、章节、表格、Do/Don't 列表、示例,保持可扫读和可执行),以及规则的引用方式。

规则文件不会自动加载,需要在 CLAUDE.md 中显式引用,例如在“Code Style”下写“Follow .claude/rules/FORMATTING.md for all code conventions.”,在“Testing”下写“See .claude/rules/TESTING.md for TDD patterns.”。跨文件引用可使用 @ 语法包含其他文件内容,如 .claude/rules/FORMATTING.md 中写 @../../baselayer/shared/rules/FORMATTING.md,从而保持规则 DRY。插件可在 shared/rules/ 中提供共享规则,项目通过相对路径或 @ 包含进行引用。

使用方式

新建规则的步骤:先确定约定范围(格式化、测试、提交等),在 .claude/rules/ 中创建 TOPIC.md,编写带表格和 Do/Don't 列表等可扫读内容,最后从 CLAUDE.md 中引用。

校验规则时可检查:文件名是否为 UPPERCASE.md;是否聚焦单一主题;结构是否可扫读(表格、列表);是否被 CLAUDE.md 引用;是否与 CLAUDE.md 内容重复。

反模式与注意事项

不要为一次性指令创建规则文件(应使用 CLAUDE.md);不要在 CLAUDE.md 与 rules/ 之间重复内容;不要创建 EVERYTHING.md 这类大杂烩文件;不要指望规则自动加载(必须被引用)。应当让每个规则文件聚焦一个主题,使用表格和列表提升可扫读性,在可用时通过 @ 引用共享规则,并记录“为什么”而不仅是“是什么”。

相关技能

claude-code-configuration(CLAUDE.md 与 settings.json)、claude-plugin-development(插件结构,包含 shared/rules/)。

限制

资料未提供该技能的安装命令、收费方式、支持平台与运行环境说明,暂未提供。