关于 explain-codebase
这项仓库 skill 用于梳理并解释代码库中的指定区域，不修改代码。它帮助开发者追踪入口、模块、调用方和数据流，并区分证据、推断与未知信息。
主要功能
- 01阅读仓库指引和相关文档
- 02确定范围及代码入口
- 03追踪模块、调用方、测试和数据流
- 04区分证据、推断与未知信息
- 05用精简文件引用说明发现
适用场景
- 01熟悉陌生的代码区域
- 02追踪请求或数据在仓库中的流转
- 03结合当前代码和 ADR 理解设计选择
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/explain-codebase确认已加载。
附带文件agents/openai.yamlskill.toml
详细介绍
解释代码库
梳理指定的代码区域，但不做任何更改。
流程
- 阅读仓库说明以及相关的现行文档、术语表或 ADR。
- 如果用户没有指定范围，则推断出最小且有用的范围。
- 检查入口点、关键模块、调用方、测试以及重要的数据流／控制流。
- 在参考历史记录前，先阅读相关 ADR。只有当用户提出要求，或现有证据无法解释重要的设计决策时，才检查特定历史记录。
- 根据用户的需求层次解释所有权和流程；区分已验证的证据、推断和未知信息。
优先采用简洁的结构：
- 用途
- 入口点和关键模块
- 调用方／数据／控制流
- 相关测试或检查
- 重要术语
- 未知信息或假设
引用具体文件，不要罗列搜索结果。除非用户切换工作流，否则不要编辑、诊断、审查或重构。如果证据表明可能存在 Bug 或架构摩擦，简要说明，并建议将 diagnose-issue 或 improve-architecture 作为单独的后续步骤。
评论
支持 Markdown