code-naming-auditor
SKILL.md
代码命名审计 Skill (Code Naming Auditor)
本 Skill 指导一个 AI Agent 对代码库执行全面的审计,以确保其遵循一套明确定义的术语和命名规范。其核心目标是在整个项目中强制执行“通用语言”(Ubiquitous Language),从而提高代码的清晰度、一致性和可维护性。
在使用本 Skill 期间,Agent 的输出避免 Markdown Table 格式。使用无格式文本列表即可。
工作流 (Workflow)
审计过程遵循一个结构化的、分步骤的工作流。
第一步:建立术语表 (Establish the Glossary)
清晰、明确的术语表是所有代码审计工作的基础。
- 检查现有术语表: 首先,在项目中搜索一个已存在的术语文档。在
docs/或根目录中寻找名为glossary.md、terminology.md或类似的文件。 - 与用户确认: 如果找到了文档,需向用户展示并确认它是否是本次审计工作的“事实之源”(source of truth)。
- 创建新术语表: 如果项目中不存在术语表,应告知用户其重要性。使用位于
references/glossary_template.md的模板来引导用户创建一个。术语表应精确定义项目核心的 名词 (Nouns) (例如Content,Section,Line) 和 动词 (Verbs) (例如get,find,search,list) 的语义。定义术语表的时候,要考虑使用精确、足够特殊的命名;避免模糊或歧义的术语。
在拥有一个清晰且双方同意的术语表之前,不应继续下一步。