关于 how
用于解释代码库运作方式及代码应放置位置的只读技能。它引导探索和综合分析,为工程师理解子系统提供架构背景。
主要功能
- 01解释代码与子系统架构
- 02评估问题复杂度和范围
- 03从不同角度探索代码
- 04综合发现并生成说明
- 05必要时检查项目中的资源副本
适用场景
- 01了解子系统的工作方式
- 02确定变更应放置的层
- 03追踪客户端与服务端流程
- 04熟悉陌生代码库并快速上手
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ overextended/ skills --skill how安装后在 Claude Code 中输入/how确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
CREDITS.mdEXPLAINER-PROMPT.mdEXPLORER-PROMPT.mdagents/openai.yaml详细介绍
运作方式
探索代码库,以回答“X 是如何工作的?”这类问题,包括“这部分应该放在哪里”以及“这属于正确的层吗”。提供架构层面的说明,深度应足以帮助资深工程师熟悉某个子系统,建立可用的心智模型,但不要详细到像带注释的源代码。
以下所有子 Agent 均为只读。它们的任务说明中包含已填好的提示词模板,并要求仅检查、不写入、不运行 git 命令。请从 ~/.config/ox/models.md 中获取每个子 Agent 的模型,并使用其步骤指定的角色,将该行中的模型和工作量参数传给子 Agent 工具。如果该行是 inherit、缺失,或者文件中的 # harness 行指定了不同的 harness,则两者都不传,让子 Agent 使用你的模型;如果文件不存在,还要建议用户运行 /setup-ox models。如果工具拒绝某个条目,请使用它列出的最接近的模型,并说明这一点。如果 harness 没有子 Agent 工具,则按顺序自行完成每一步。
如果问题涉及服务器正在运行、但本仓库不拥有的资源(ox_inventory、ox_core、某个框架),请读取服务器资源目录中的副本。该目录可通过从当前目录向上查找 .ox/config.md,并读取其中的 server root 和 resources dir 行来定位。该副本就是服务器实际运行的版本。如果文件缺失,请自行查找该资源,说明这一点,并建议用户运行 /setup-ox。
1. 评估复杂度
如果范围不明确,请说明你的理解并进行探索。用户可以纠正方向。
- 简单(单个模块、小型实用工具、范围较窄的问题,例如“这个回调是如何工作的”):不使用探索器。启动一个
explore子 Agent,依据 EXPLAINER-PROMPT.md 构建提示词,排除标记为 complex only 的部分,让它一次性完成探索和说明。然后进入第 4 步。 - 复杂(跨多个文件或资源的子系统、跨越客户端/服务器边界的流程、完整的架构概述):进入第 2 步。
拿不准时,选择简单路径。
2. 探索(仅限复杂问题)
将问题拆分为 2 到 4 个角度,每个角度覆盖子系统中一个不同的部分。在 FiveM 资源中,通常可按客户端、服务器、NUI、两者之间的边界(网络事件、lib.callback、导出、状态袋)以及数据(数据库表、data/ 文件、Convar)进行划分。立即启动所有探索器:每个都是一个 explore 子 Agent,使用 EXPLORER-PROMPT.md,并填入各自的角度。
3. 综合(仅限复杂问题)
所有探索器都返回后,启动一个 hardest tasks 子 Agent,使用 EXPLAINER-PROMPT.md,并填入所有探索器的发现。
4. 呈现
呈现说明者的输出。可以根据上下文对表述或背景信息做少量调整,但不要大幅改写。
输出格式
说明应使用 EXPLAINER-PROMPT.md 中定义的章节,删除不适用的章节:概述、关键概念、工作原理、代码位置、注意事项。