code-naming-auditor
Installation
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) 的语义。定义术语表的时候,要考虑使用精确、足够特殊的命名;避免模糊或歧义的术语。
在拥有一个清晰且双方同意的术语表之前,不应继续下一步。
Related skills
More from cafe3310/public-agent-skills
weekly-report-writer
此技能通过综合 Obsidian 笔记库中的文档进度来起草周报。适用于用户希望基于最近创建的文件、上一份报告和项目背景文档生成每周摘要的场景。
57im-local-kb
IM 知识整理和分析技能,专注于从聊天记录中提取高价值的知识。
31project-learner
结构化交互式学习助手,当用户希望学习项目相关知识、特定代码文件或底层技术时使用此技能,它会将学习过程记录为持久化的 Markdown 日志。
26media-organizer
与用户协作,根据项目约定,将媒体文件目录组织成结构化、分类化和文档化的格式。
20doc-todo-log-loop
基于日志记录驱动的轻量级项目开发和管理方案。如果用户在项目章程提及,应使用此技能。
19git-snapshot-rollback
在 Git 开发中,当需要放弃当前尝试并回退到某个历史提交时使用。它会自动将当前状态存档至 archive/ 分支,并在 ARCHIVE.md 中建立双向链接(来源与目标),确保开发决策流的可追溯性。适用于需要安全回退且保留失败尝试上下文的场景。
17