$npx -y skills add agentscope-ai/QwenPaw --skill QA_source_index-zh将用户问题中的主题、关键词映射到 QwenPaw 官方文档路径与常见源码入口,减少盲目搜索。适用于内置 QA Agent 在回答安装、配置、技能、MCP、多智能体、记忆、CLI 等问题时快速选定要读的文件。
| 1 | # 文档与源码速查 |
| 2 | |
| 3 | 回答 **安装、配置、行为原理** 类问题时,先 **按关键词归类**,再按下表 **打开 1~2 个最可能命中的路径** 阅读,避免长时间无目的遍历。 |
| 4 | |
| 5 | ## 使用步骤 |
| 6 | |
| 7 | 1. 从用户问题中提取主题(对照下表左列或同类词)。 |
| 8 | 2. 解析 **`$QWENPAW_ROOT`**:以 `which qwenpaw` 得到可执行路径,若为 `…/.qwenpaw/bin/qwenpaw` 则源码根为其上三级目录(与 **guidance** skill 一致);否则结合用户给出的安装路径判断。 |
| 9 | 3. 先解析 **`$DOCS_DIR`**(兼容多种安装方式):执行 `python3 -c "from qwenpaw.constant import DOCS_DIR; print(DOCS_DIR or '')" 2>/dev/null`。若返回有效路径则直接使用;否则 fallback 到 `$QWENPAW_ROOT/website/public/docs/`。 |
| 10 | 4. **先读文档** `$DOCS_DIR/<专题>.<语言>.md`(语言取与用户一致:`zh` / `en`),仍不足再读表中 **源码入口**。 |
| 11 | |
| 12 | ## 主题 / 关键词 → 优先文档与源码 |
| 13 | |
| 14 | | 主题或关键词(示例) | 优先文档(`$DOCS_DIR/`) | 常见源码入口(相对 `$QWENPAW_ROOT`) | |
| 15 | |---------------------|-----------------------------------|-----------------------------------| |
| 16 | | 安装、依赖、首次使用 | `quickstart`、`intro` | `src/qwenpaw/cli/`、`pyproject.toml` | |
| 17 | | 配置、config.json、环境变量 | `config` | `src/qwenpaw/config/config.py`、`src/qwenpaw/constant.py` | |
| 18 | | 技能、SKILL、skill_pool、内置技能 | `skills` | `src/qwenpaw/agents/skill_system/`、`src/qwenpaw/agents/skills/` | |
| 19 | | MCP、插件 | `mcp` | `src/qwenpaw/app/routers/`(按需 grep `mcp`) | |
| 20 | | 多智能体、工作区、agent、内置 QA | `multi-agent` | `src/qwenpaw/app/routers/agents.py`、`src/qwenpaw/app/migration.py`、`src/qwenpaw/constant.py`(`BUILTIN_QA_AGENT_ID` 等) | |
| 21 | | 记忆、MEMORY、memory_search | `memory` | `src/qwenpaw/agents/memory/memory_manager.py`、`src/qwenpaw/agents/tools/memory_search.py` | |
| 22 | | 控制台、前端 | `console` | `console/` | |
| 23 | | 命令行、子命令、init | `cli` | `src/qwenpaw/cli/`(如 `init_cmd.py`) | |
| 24 | | 频道、会话 | `channels` | 在 `src/qwenpaw` 下按 `channels` 关键词检索 | |
| 25 | | 上下文、窗口 | `context` | `config` 文档 + `src/qwenpaw/agents/` 相关逻辑 | |
| 26 | | 模型、API Key | `models` | `src/qwenpaw/config/config.py` | |
| 27 | | 心跳、HEARTBEAT | `heartbeat` | 在 `src/qwenpaw` 下检索 `heartbeat` / `HEARTBEAT` | |
| 28 | | 桌面客户端 | `desktop` | `desktop/`(若仓库中存在) | |
| 29 | | 安全 | `security` | 先读 `security.<lang>.md` | |
| 30 | | 报错、常见问题 | `faq` | 先 `faq.<lang>.md`,再针对性看源码 | |
| 31 | | 命令与斜杠指令 | `commands` | `src/qwenpaw` 下与 CLI/命令注册相关的模块(按需检索) | |
| 32 | |
| 33 | ## 约定 |
| 34 | |
| 35 | - 文档完整路径:`$DOCS_DIR/<专题>.<语言>.md`(无对应语言时用 `.en.md` 兜底)。优先使用 `qwenpaw.constant` 中的 `DOCS_DIR`,失败时 fallback 到 `$QWENPAW_ROOT/website/public/docs/`。 |
| 36 | - 表中 **源码入口** 为起点;应用 `read_file` 或局部 `grep` 缩小到具体符号,不要一次性通读大目录 listing。 |
| 37 | |
| 38 | ## 注意 |
| 39 | |
| 40 | - 本 skill **不替代** `read_file`:锁定候选路径后应立即读取并核对。 |
| 41 | - 若某路径在本地不存在(例如未带源码的安装树),以 **已安装的文档包** 或用户提供的根目录为准,并明确告知依据路径。 |