refactor: 完善 todo 和 wiki skill 的自包含操作指南

- todo: 明确 mysql_query MCP 工具调用方式,补充触发词和字段说明
- todo/setup: 补充 QwenPaw 和 Claude Code 两种配置方式,修正环境变量名
- wiki: 用 glob_search 替换 <skill-path> 占位符,流程更清晰
This commit is contained in:
2026-09-01 20:58:53 +08:00
parent be7720e732
commit 14e93d2001
3 changed files with 157 additions and 139 deletions
+36 -33
View File
@@ -13,17 +13,28 @@ description: |
## 工作流程
### 1. SSH 连通性检查
### 1. 查找 skill 路径
在操作仓库之前,先运行 SSH 检查脚本:
本 skill 的脚本和模板位于 skill 目录下。查找方法:
```
# 用 glob_search 找到本 skill 的位置
glob_search(pattern="**/wiki/SKILL.md")
```
找到后,skill 目录路径为结果中 `SKILL.md` 所在的目录(去掉 `/SKILL.md` 后缀)。
后续步骤中用 `<skill-dir>` 代指该路径。
### 2. SSH 连通性检查
```bash
bash <skill-path>/scripts/check_ssh.sh
bash <skill-dir>/scripts/check_ssh.sh
```
如果检查失败,告知用户需要配置 SSH 密钥,不要继续操作。
### 2. 克隆仓库
### 3. 克隆仓库
```bash
TMP_DIR=$(mktemp -d)
@@ -32,31 +43,30 @@ git clone ssh://git@47.121.181.112:222/wonder/docs.git "$TMP_DIR"
后续所有文件操作在 `$TMP_DIR` 中进行。
### 3. 理解用户意图
用户可能以不同方式使用此 skill:
### 4. 理解用户意图
**场景 A — 提供主题**:用户说"写一篇关于 XXX 的文章"
- 根据主题判断应该放在哪个章节(algorithm/architecture/project/qiniu-cloud)
- 如果章节不明确,询问用户
- 根据主题判断章节(algorithm / architecture / project / qiniu-cloud)
- 不确定时询问用户
- 按模板生成完整文档
**场景 B — 提供内容**:用户粘贴了一段文档或笔记
- 分析内容主题,判断合适的章节
- 整理成标准格式(参考 `references/article-template.md`)
- 如果内容不完整,询问用户补充
- 分析内容主题,判断合适章节
- 整理成标准格式(参考 `<skill-dir>/references/article-template.md`)
- 内容不完整时询问用户补充
**场景 C — 更新现有文档**:用户说"更新 XXX 文章"
- 在仓库中找到对应文件
- 根据用户要求更新内容
**场景 D — 章节不明确**:无法确定放在哪里
- 列出当前仓库的章节结构供用户选择
- 询问用户该内容属于哪个章节,或是否需要新建章节
**场景 D — 章节不明确**:
- 先查看仓库目录结构:`ls $TMP_DIR/`
- 列出当前章节供用户选择
- 询问是否需要新建章节
### 4. 生成/更新文档
### 5. 生成/更新文档
遵循 `references/article-template.md` 中的标准格式。关键要点:
遵循 `<skill-dir>/references/article-template.md` 中的标准格式:
- 使用中文撰写
- 代码示例以 Go 为主
@@ -64,13 +74,13 @@ git clone ssh://git@47.121.181.112:222/wonder/docs.git "$TMP_DIR"
- 包含常见陷阱和练习题
- 文件名使用 kebab-case
### 5. 更新导航
### 6. 更新导航
修改 `mkdocs.yml` 的 `nav` 字段,将新文档添加到正确位置,或根据用户指示修改已有条目。
修改 `$TMP_DIR/mkdocs.yml` 的 `nav` 字段,将新文档添加到正确位置。
参考 `references/mkdocs-nav.md` 了解当前导航结构和规范。
参考 `<skill-dir>/references/mkdocs-nav.md` 了解当前导航结构。
### 6. 提交并推送
### 7. 提交并推送
```bash
cd "$TMP_DIR"
@@ -79,25 +89,18 @@ git commit -m "docs: 添加/更新 <文档标题>"
git push origin main
```
提交信息遵循 Conventional Commits 格式(参考全局 CLAUDE.md 规范)。
### 7. 清理
### 8. 清理
```bash
rm -rf "$TMP_DIR"
```
告知用户文档已推送,CI/CD 会自动部署。
告知用户文档已推送,CI/CD 通常 1-2 分钟自动部署。
## 交互原则
- **章节不确定时必须询问**:不要擅自决定文档位置
- **内容不明确时必须询问**:不要编造技术内容
- **确认用户意图**:在生成大量内容前,先确认主题和范围
- **保持一致性**:新文档的风格应与现有文档一致
## 注意事项
- 根据用户指示可以修改已有的 nav 条目(重命名、移动位置、删除等)
- 如果需要新建目录,同时创建该目录的 `index.md`
- 推送后告知用户 CI/CD 部署通常需要 1-2 分钟
- **确认用户意图**:生成大量内容前,先确认主题和范围
- **保持一致性**:新文档风格与现有文档一致
- **新建目录时**:同时创建该目录的 `index.md`