mcpField
H
how

how

github.com/ericlitman开发55447 次安装2 周前更新
代码仓库

关于 how

how 是一项只读开发技能,用于解释代码库各部分的工作方式。它指导探索与综合,产出适合工程师了解子系统架构的说明。

主要功能

  1. 01只读探索代码库
  2. 02按复杂度规划探索
  3. 03架构说明格式
  4. 04按提供方分派角色

适用场景

  1. 01解释子系统的工作方式
  2. 02编写入门概览
  3. 03梳理跨模块功能

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ericlitman/open-pstack --skill how

安装后在 Claude Code 中输入/how确认已加载。

附带文件references/explainer-prompt.mdreferences/explorer-prompt.md

详细介绍

工作原理

探索代码库,回答“X 是如何工作的?”这类问题。提供架构层面的解释,帮助资深工程师熟悉子系统并建立可用的心智模型,但不要细到像是在逐行注释源代码。

调度约定。 通过 provider-dispatch.md 解析每个已配置的角色。值是带有提供方限定的描述符;由父级选择使用原生执行还是外部执行。每个通道都以 read-only 模式运行。探索者使用 how explorer 描述符,所有讲解者都使用 how explainer 描述符。如果配置表缺少其中任一条目,则使用该角色的默认设置。原生通道使用父级的子 Agent 原语;外部通道直接使用启动器。在 Codex 上,通过 codex-tools.md 解析剩余的 Claude 工具名称。根据任务需要,为每个子 Agent 选择适当的工作量,参照 poteto-mode 技能的 Subagents 部分。

1. 评估复杂度

如果范围不明确,请说明你的理解并开始探索。用户可以纠正方向。

  • 简单(单个模块、小型工具,或“函数 X 是如何工作的”这类范围较窄的问题):无需探索者。派发一名讲解者,在一轮中完成探索和讲解,并根据 references/explainer-prompt.md 编写提示词,不包含探索结果部分。转到第 4 步。
  • 复杂(涉及多个文件或服务的子系统、跨领域功能、完整的架构概述):转到第 2 步。

不确定时,选择简单路径。

2. 探索(仅限复杂问题)

将问题拆分为 2 到 4 个角度,每个角度对应子系统中一个不同的部分。在一个扇出阶段启动所有探索者,每个探索者都使用 references/explorer-prompt.md,并填入对应的角度。

3. 综合(仅限复杂问题)

等待所有探索者返回后,派发一名讲解者,使用 references/explainer-prompt.md 并填入所有探索者的发现。

4. 呈现

呈现讲解者的输出。可以根据上下文进行少量润色以提升清晰度,但不要大幅改写。

输出格式

解释应采用 references/explainer-prompt.md 中定义的章节,并删除不适用的章节:概述、关键概念、工作原理、代码位置、注意事项。

评论

支持 Markdown