强制规范:AI 改动模块代码时需同步创建/更新模块文档与索引,保持文档与代码一致。
/plugin marketplace add taptap/claude-plugins-marketplace/plugin install spec@taptap-pluginsThis skill inherits all available tools. When active, it can use any tool Claude has access to.
scripts/check-docs.pyscripts/check-stale-docs.py项目使用分层文档系统帮助AI快速定位代码模块,避免上下文被占满:
tap-agents/prompts/module-map.md - 根索引,列出所有模块和快速定位表tap-agents/prompts/modules/[模块名].md - 各模块详细文档检查 tap-agents/tap-agents-configs.md 是否存在
路径约定:本文档中所有以 tap-agents/ 开头的路径均指项目根目录下的对应路径。
当你在「业务模块目录」/下创建新的顶层文件夹(模块)时,必须:
tap-agents/prompts/modules/下创建对应的[模块名].mdtap-agents/prompts/module-map.md,添加模块描述当你修改某个模块的代码时(新增主要类、修改核心功能),必须:
tap-agents/prompts/modules/[模块名].md)主要类的定义:
使用配置文件中的「主要类后缀」、「文件扩展名」配置项。
不需要更新文档的情况:
当进行跨模块重构、删除模块、移动代码时,必须:
module-map.md中标记废弃的模块情况A:代码比文档新(最常见) 特征:
AI行为:
自动同步 - YYYY-MM-DD检测到 [模块名] 文档过期,已自动更新情况B:无法判断谁是对的 特征:
AI行为:
情况C:文档明显错误 特征:
AI行为:
修复错误 - YYYY-MM-DD这是强制性规则,必须自动执行,不需要询问用户
核心原则:代码有修改 + 文档不存在 = 必须创建文档
触发条件:
只要在 「业务模块目录」/[模块名]/ 下进行了代码修改(无论大小、类型),且该模块没有对应的文档 tap-agents/prompts/modules/[模块名].md,就必须自动创建文档。
自动执行流程:
tap-agents/prompts/modules/[模块名].md 是否存在。已创建 [模块名] 模块文档执行示例:
场景:修复了 UI 样式,但文档不存在
用户:修复热榜页面背景图片显示问题
AI执行:
1. 修改代码:「业务模块目录」/Moment/HotEvents/XXXViewController.「文件扩展名」
2. 检查文档:tap-agents/prompts/modules/Moment.md 不存在
3. [触发规则] 创建文档:生成 Moment.md
4. 通知用户:已创建 Moment 模块文档
最终响应:"背景图片问题已修复。已创建 Moment 模块文档"
注意: 如果文档已存在,则按规则2(更新文档)或规则(忽略微小修改)处理。本规则仅针对文档缺失的情况。
# [模块名]
## 模块简介
一句话描述这个模块的作用和职责。
## 核心功能
- 功能1:简短描述
- 功能2:简短描述
- 功能3:简短描述
## 主要类/文件
| 文件名 | 说明 | 常用叫法/位置描述 |
| ----------------------- | ---------- | ---------------------- |
| XXXViewController | 主控制器 | 主页、首页 |
| XXXTopView | 顶部视图 | 头部、顶部区域、banner |
| XXXManager | 业务管理类 | 管理器、业务层 |
## 关键词
搜索关键词1, 关键词2, 关键词3
## 常用叫法映射(可选)
记录团队内部的口语化表达和对应的代码位置:
- "头部" / "顶部区域" → XXXTopView
- "底部按钮" / "操作栏" → XXXBottomView
- "列表" / "信息流" → XXXListViewController
## 最后更新
YYYY-MM-DD
开发场景1:新增功能
用户:帮我在GameDetail模块添加分享功能
AI工作流:
1. 实现代码功能
2. 读取 tap-agents/prompts/modules/GameDetail.md
3. 在"核心功能"中添加"分享功能"
4. 在"主要类/文件"中添加新增的类
5. 更新"最后更新"时间
6. 提示:"已完成分享功能,并更新了GameDetail模块文档"
开发场景2:定位需求
用户:修改评分显示样式
AI工作流:
1. 读取 tap-agents/prompts/module-map.md 查找"评分"关键词
2. 定位到相关模块
3. 读取 tap-agents/prompts/modules/[模块名].md 找到具体文件
4. 实现修改
5. 判断:仅样式修改,不需要更新文档
项目提供了两个辅助脚本用于检查文档状态:
何时建议用户运行脚本:
check-docs.py - 检查缺少文档的模块
python [check-docs.py 路径] --modules-dir [TapTap 业务根目录] --docs-dir [tap-agents/prompts/modules 文档目录]check-stale-docs.py - 检查可能过期的文档
python [check-stale-docs.py 路径] --modules-dir [TapTap 业务根目录] --docs-dir [tap-agents/prompts/modules 文档目录]AI的职责:
This skill should be used when the user asks to "create an agent", "add an agent", "write a subagent", "agent frontmatter", "when to use description", "agent examples", "agent tools", "agent colors", "autonomous agent", or needs guidance on agent structure, system prompts, triggering conditions, or agent development best practices for Claude Code plugins.
This skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.
This skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", "use ${CLAUDE_PLUGIN_ROOT}", "set up event-driven automation", "block dangerous commands", or mentions hook events (PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification). Provides comprehensive guidance for creating and implementing Claude Code plugin hooks with focus on advanced prompt-based hooks API.