@hupan56/wlkj 2.6.0 → 2.7.0

package/templates/root//344/275/277/347/224/250/350/257/264/346/230/216.md

@@ -1,259 +1,259 @@
-# 完整使用说明
-
-> 从零开始，一步一步来。连 Python 都没有也能跟着做。
-
----
-
-## 第一步：装前置环境（10 分钟）
-
-### 1.1 装 Node.js（必须）
-
-Node.js 用来跑 `npx` 安装命令。
-
-**Windows：**
-1. 打开 https://nodejs.org
-2. 下载 **LTS 版**（左边那个绿色按钮）
-3. 双击安装，一路点"下一步"，全部默认
-4. 装完按 `Win + R`，输 `cmd` 回车，在黑窗口里输：
-   ```
-   node --version
-   ```
-   看到 `v20.x.x` 之类的就成功了
-
-**Mac：**
-1. 打开终端（Launchpad → 其他 → 终端）
-2. 输：`brew install node`（没装 brew 的先去 brew.sh 装）
-3. 验证：`node --version`
-
-### 1.2 装 Python（必须）
-
-Python 用来跑工作流的脚本引擎。
-
-**Windows：**
-1. 打开 https://www.python.org/downloads/
-2. 点黄色大按钮 "Download Python 3.x.x"
-3. 双击安装包，**重要：勾选底部 "Add Python to PATH"**，再点 "Install Now"
-4. 装完在 cmd 里输：
-   ```
-   python --version
-   ```
-   看到 `Python 3.9.x` 或更高就成功了
-
-**Mac：**
-1. 终端输：`brew install python`
-2. 验证：`python3 --version`
-
-### 1.3 装 git（推荐，不装也能用大部分功能）
-
-git 用来团队协作和拉取源码。**没有 git 不影响写 PRD、建任务、出报告。**
-
-**Windows：**
-1. 打开 https://git-scm.com/download/win
-2. 下载自动安装包，双击安装，全部默认
-3. 验证：`git --version`
-
-**Mac：**
-- 打开终端，第一次输 `git` 时 Mac 会提示安装，点"安装"即可
-- 或手动：`brew install git`
-
----
-
-## 第二步：创建项目并安装工作流（2 分钟）
-
-### 2.1 建项目文件夹
-
-**Windows：**
-```
-mkdir D:\我的项目
-cd D:\我的项目
-```
-
-**Mac：**
-```
-mkdir ~/我的项目
-cd ~/我的项目
-```
-
-### 2.2 一键安装
-
-```
-npx @hupan56/wlkj init
-```
-
-它会自动：
-- 下载并安装完整工作流引擎
-- 问你叫什么名字（或从 git 配置读）
-- 注册你的身份
-- 如果有 git，自动配置
-- 如果配了源码地址，自动拉取源码并建索引
-
-看到这个就成功了：
-```
-✓ 开发者: 你的名字
-安装完成! 现在可以开始了
-```
-
-> 也可以指定名字：`npx @hupan56/wlkj init 小王`
-
----
-
-## 第三步：开始使用
-
-### 方式 A：用 Qoder 客户端（推荐）
-
-如果你装了 **Qoder IDE / Quest / QoderWork**：
-
-1. 用 Qoder 打开你刚创建的项目文件夹
-2. 在对话框里直接说中文：
-   - "写个保险异常筛选的需求"
-   - "查一下考勤代码在哪"
-   - "建个任务：登录优化"
-3. 或输入 `/` 看所有命令（`/wl-prd` `/wl-search` 等）
-
-**看不到 `/` 命令？**
-- Quest 模式：新建一个对话
-- QoderWork：跑 `python .qoder/scripts/install_qoderwork.py`，然后重启 QoderWork
-
-### 方式 B：用命令行（无 Qoder 时）
-
-```
-python .qoder/scripts/search_index.py 保险
-python .qoder/scripts/task.py create "登录优化"
-python .qoder/scripts/report.py daily
-```
-
----
-
-## 全部功能速查
-
-### 写需求 + 原型
-
-| 做什么 | 说什么 / 命令 |
-|--------|-------------|
-| 写完整需求 | "写个 XXX 的需求" 或 `/wl-prd` |
-| 写小改动 | "快速写个 XXX" |
-| 头脑风暴 | "脑暴一下 XXX" |
-| 画原型 | 随需求自动生成 |
-| 评审 PRD | "评审这个 PRD" |
-
-### 查代码（不懂代码也能查）
-
-| 做什么 | 说什么 / 命令 |
-|--------|-------------|
-| 找业务代码 | "保险的代码在哪" 或 `/wl-search 保险` |
-| 找 API | `/wl-search --api 考勤` |
-| 找字段用法 | `/wl-search --field nickName` |
-| 找同类页面 | `/wl-search --style table` |
-| 一键全上下文 | `python .qoder/scripts/context_pack.py 保险 --platform web` |
-
-### 管任务
-
-| 做什么 | 说什么 / 命令 |
-|--------|-------------|
-| 建任务 | "建个任务：登录优化" |
-| 设截止日期 | `python .qoder/scripts/task.py set-due 任务名 2026-07-15` |
-| 标记依赖 | `python .qoder/scripts/task.py block A B`（A 被 B 阻塞） |
-| 看能开始的 | `python .qoder/scripts/task.py list --ready` |
-| 看被卡住的 | `python .qoder/scripts/task.py list --blocked` |
-| 看甘特图 | `python .qoder/scripts/task.py gantt` |
-| 完成任务 | "这个任务做完了" |
-
-### 看进度 + 出报告
-
-| 做什么 | 说什么 / 命令 |
-|--------|-------------|
-| 看项目健康度 | "项目怎么样" 或 `python .qoder/scripts/status.py` |
-| 出日报 | "今天干了啥" 或 `python .qoder/scripts/report.py daily` |
-| 出周报 | `python .qoder/scripts/report.py weekly` |
-
-### 导出
-
-| 做什么 | 命令 |
-|--------|------|
-| 导 Jira CSV | `python .qoder/scripts/export.py jira` |
-| 导 OpenAPI | `python .qoder/scripts/export.py openapi --project 你的项目` |
-| 查调用图 | `python .qoder/scripts/export.py callgraph --class ClassName` |
-
-### 团队协作
-
-| 做什么 | 说什么 / 命令 |
-|--------|-------------|
-| 同步给团队 | "同步" 或 `python .qoder/scripts/team_sync.py push` |
-| 拉取队友最新 | "拉取最新" 或 `python .qoder/scripts/team_sync.py pull` |
-| 看同步状态 | `python .qoder/scripts/team_sync.py status` |
-
----
-
-## 团队配置（团队负责人做一次）
-
-### 填源码仓库地址
-
-打开 `.qoder/config.yaml`，找到这段，改成你们的 git 地址：
-
-```yaml
-git_sync:
-  projects:
-    你的项目名:                              # ← 改成你的项目名
-      url: http://你的git服务器/你的项目.git  # ← 改成你的
-      branch: main                           # ← 改成你的主分支
-```
-
-> 不知道填什么？注释掉整段，手动把代码放到 `data/code/项目名/` 也行。
-
-### 注册周五自动更新（全队只需一台机器）
-
-```
-python .qoder/scripts/setup_weekly_cron.bat
-```
-
-### 配飞书通知（可选）
-
-`.qoder/config.yaml` 里：
-
-```yaml
-feishu:
-  enabled: true
-  webhook_url: "https://open.feishu.cn/open-apis/bot/v2/hook/你的token"
-```
-
----
-
-## 常见问题
-
-### 安装时
-
-| 问题 | 解决 |
-|------|------|
-| `npx` 命令找不到 | 先装 Node.js（见第一步） |
-| `python` 命令找不到 | 先装 Python（见第一步），**勾选 Add to PATH** |
-| setup.py 报错 | 跑 `python .qoder/scripts/init_doctor.py --fix` 自动修复 |
-
-### 使用时
-
-| 问题 | 解决 |
-|------|------|
-| 搜索没结果 | 先跑 `python .qoder/scripts/setup.py` 建索引 |
-| Qoder 里看不到 `/` 命令 | 新建对话 / 重启 QoderWork |
-| 命令报错 | `python .qoder/scripts/init_doctor.py --fix` |
-| 索引过期 | `python .qoder/scripts/git_sync.py --index-only` |
-
-### 速查
-
-```
-安装         → npx @hupan56/wlkj init
-环境修复     → python .qoder/scripts/init_doctor.py --fix
-重新初始化   → python .qoder/scripts/setup.py
-性能测试     → python .qoder/scripts/benchmark.py
-```
-
----
-
-## 环境要求总结
-
-| 环境 | 必须？ | 版本 |
-|------|--------|------|
-| **Node.js** | 必须（装工作流用） | 16+ |
-| **Python** | 必须（跑引擎） | 3.9+ |
-| **git** | 推荐（团队协作用，不装也能用核心功能） | 任意 |
-| **Qoder 客户端** | 推荐（AI 对话驱动，不装也能用命令行） | IDE/Quest/QoderWork 任一 |
-| **飞书** | 可选（通知推送） | 有群机器人即可 |
+# 完整使用说明
+
+> 从零开始，一步一步来。连 Python 都没有也能跟着做。
+
+---
+
+## 第一步：装前置环境（10 分钟）
+
+### 1.1 装 Node.js（必须）
+
+Node.js 用来跑 `npx` 安装命令。
+
+**Windows：**
+1. 打开 https://nodejs.org
+2. 下载 **LTS 版**（左边那个绿色按钮）
+3. 双击安装，一路点"下一步"，全部默认
+4. 装完按 `Win + R`，输 `cmd` 回车，在黑窗口里输：
+   ```
+   node --version
+   ```
+   看到 `v20.x.x` 之类的就成功了
+
+**Mac：**
+1. 打开终端（Launchpad → 其他 → 终端）
+2. 输：`brew install node`（没装 brew 的先去 brew.sh 装）
+3. 验证：`node --version`
+
+### 1.2 装 Python（必须）
+
+Python 用来跑工作流的脚本引擎。
+
+**Windows：**
+1. 打开 https://www.python.org/downloads/
+2. 点黄色大按钮 "Download Python 3.x.x"
+3. 双击安装包，**重要：勾选底部 "Add Python to PATH"**，再点 "Install Now"
+4. 装完在 cmd 里输：
+   ```
+   python --version
+   ```
+   看到 `Python 3.9.x` 或更高就成功了
+
+**Mac：**
+1. 终端输：`brew install python`
+2. 验证：`python3 --version`
+
+### 1.3 装 git（推荐，不装也能用大部分功能）
+
+git 用来团队协作和拉取源码。**没有 git 不影响写 PRD、建任务、出报告。**
+
+**Windows：**
+1. 打开 https://git-scm.com/download/win
+2. 下载自动安装包，双击安装，全部默认
+3. 验证：`git --version`
+
+**Mac：**
+- 打开终端，第一次输 `git` 时 Mac 会提示安装，点"安装"即可
+- 或手动：`brew install git`
+
+---
+
+## 第二步：创建项目并安装工作流（2 分钟）
+
+### 2.1 建项目文件夹
+
+**Windows：**
+```
+mkdir D:\我的项目
+cd D:\我的项目
+```
+
+**Mac：**
+```
+mkdir ~/我的项目
+cd ~/我的项目
+```
+
+### 2.2 一键安装
+
+```
+npx @hupan56/wlkj init
+```
+
+它会自动：
+- 下载并安装完整工作流引擎
+- 问你叫什么名字（或从 git 配置读）
+- 注册你的身份
+- 如果有 git，自动配置
+- 如果配了源码地址，自动拉取源码并建索引
+
+看到这个就成功了：
+```
+✓ 开发者: 你的名字
+安装完成! 现在可以开始了
+```
+
+> 也可以指定名字：`npx @hupan56/wlkj init 小王`
+
+---
+
+## 第三步：开始使用
+
+### 方式 A：用 Qoder 客户端（推荐）
+
+如果你装了 **Qoder IDE / Quest / QoderWork**：
+
+1. 用 Qoder 打开你刚创建的项目文件夹
+2. 在对话框里直接说中文：
+   - "写个保险异常筛选的需求"
+   - "查一下考勤代码在哪"
+   - "建个任务：登录优化"
+3. 或输入 `/` 看所有命令（`/wl-prd-full` `/wl-search` 等）
+
+**看不到 `/` 命令？**
+- Quest 模式：新建一个对话
+- QoderWork：跑 `python .qoder/scripts/install_qoderwork.py`，然后重启 QoderWork
+
+### 方式 B：用命令行（无 Qoder 时）
+
+```
+python .qoder/scripts/search_index.py 保险
+python .qoder/scripts/task.py create "登录优化"
+python .qoder/scripts/report.py daily
+```
+
+---
+
+## 全部功能速查
+
+### 写需求 + 原型
+
+| 做什么 | 说什么 / 命令 |
+|--------|-------------|
+| 写完整需求 | "写个 XXX 的需求" 或 `/wl-prd-full` |
+| 写小改动 | "快速写个 XXX" |
+| 头脑风暴 | "脑暴一下 XXX" |
+| 画原型 | 随需求自动生成 |
+| 评审 PRD | "评审这个 PRD" |
+
+### 查代码（不懂代码也能查）
+
+| 做什么 | 说什么 / 命令 |
+|--------|-------------|
+| 找业务代码 | "保险的代码在哪" 或 `/wl-search 保险` |
+| 找 API | `/wl-search --api 考勤` |
+| 找字段用法 | `/wl-search --field nickName` |
+| 找同类页面 | `/wl-search --style table` |
+| 一键全上下文 | `python .qoder/scripts/context_pack.py 保险 --platform web` |
+
+### 管任务
+
+| 做什么 | 说什么 / 命令 |
+|--------|-------------|
+| 建任务 | "建个任务：登录优化" |
+| 设截止日期 | `python .qoder/scripts/task.py set-due 任务名 2026-07-15` |
+| 标记依赖 | `python .qoder/scripts/task.py block A B`（A 被 B 阻塞） |
+| 看能开始的 | `python .qoder/scripts/task.py list --ready` |
+| 看被卡住的 | `python .qoder/scripts/task.py list --blocked` |
+| 看甘特图 | `python .qoder/scripts/task.py gantt` |
+| 完成任务 | "这个任务做完了" |
+
+### 看进度 + 出报告
+
+| 做什么 | 说什么 / 命令 |
+|--------|-------------|
+| 看项目健康度 | "项目怎么样" 或 `python .qoder/scripts/status.py` |
+| 出日报 | "今天干了啥" 或 `python .qoder/scripts/report.py daily` |
+| 出周报 | `python .qoder/scripts/report.py weekly` |
+
+### 导出
+
+| 做什么 | 命令 |
+|--------|------|
+| 导 Jira CSV | `python .qoder/scripts/export.py jira` |
+| 导 OpenAPI | `python .qoder/scripts/export.py openapi --project 你的项目` |
+| 查调用图 | `python .qoder/scripts/export.py callgraph --class ClassName` |
+
+### 团队协作
+
+| 做什么 | 说什么 / 命令 |
+|--------|-------------|
+| 同步给团队 | "同步" 或 `python .qoder/scripts/team_sync.py push` |
+| 拉取队友最新 | "拉取最新" 或 `python .qoder/scripts/team_sync.py pull` |
+| 看同步状态 | `python .qoder/scripts/team_sync.py status` |
+
+---
+
+## 团队配置（团队负责人做一次）
+
+### 填源码仓库地址
+
+打开 `.qoder/config.yaml`，找到这段，改成你们的 git 地址：
+
+```yaml
+git_sync:
+  projects:
+    你的项目名:                              # ← 改成你的项目名
+      url: http://你的git服务器/你的项目.git  # ← 改成你的
+      branch: main                           # ← 改成你的主分支
+```
+
+> 不知道填什么？注释掉整段，手动把代码放到 `data/code/项目名/` 也行。
+
+### 注册周五自动更新（全队只需一台机器）
+
+```
+python .qoder/scripts/setup_weekly_cron.bat
+```
+
+### 配飞书通知（可选）
+
+`.qoder/config.yaml` 里：
+
+```yaml
+feishu:
+  enabled: true
+  webhook_url: "https://open.feishu.cn/open-apis/bot/v2/hook/你的token"
+```
+
+---
+
+## 常见问题
+
+### 安装时
+
+| 问题 | 解决 |
+|------|------|
+| `npx` 命令找不到 | 先装 Node.js（见第一步） |
+| `python` 命令找不到 | 先装 Python（见第一步），**勾选 Add to PATH** |
+| setup.py 报错 | 跑 `python .qoder/scripts/init_doctor.py --fix` 自动修复 |
+
+### 使用时
+
+| 问题 | 解决 |
+|------|------|
+| 搜索没结果 | 先跑 `python .qoder/scripts/setup.py` 建索引 |
+| Qoder 里看不到 `/` 命令 | 新建对话 / 重启 QoderWork |
+| 命令报错 | `python .qoder/scripts/init_doctor.py --fix` |
+| 索引过期 | `python .qoder/scripts/git_sync.py --index-only` |
+
+### 速查
+
+```
+安装         → npx @hupan56/wlkj init
+环境修复     → python .qoder/scripts/init_doctor.py --fix
+重新初始化   → python .qoder/scripts/setup.py
+性能测试     → python .qoder/scripts/benchmark.py
+```
+
+---
+
+## 环境要求总结
+
+| 环境 | 必须？ | 版本 |
+|------|--------|------|
+| **Node.js** | 必须（装工作流用） | 16+ |
+| **Python** | 必须（跑引擎） | 3.9+ |
+| **git** | 推荐（团队协作用，不装也能用核心功能） | 任意 |
+| **Qoder 客户端** | 推荐（AI 对话驱动，不装也能用命令行） | IDE/Quest/QoderWork 任一 |
+| **飞书** | 可选（通知推送） | 有群机器人即可 |