286 lines
6.6 KiB
Markdown
286 lines
6.6 KiB
Markdown
---
|
||
name: ws-maint
|
||
description: 工作区文档润色维护，触发词为"润色 xxx"或"/润色 xxx"
|
||
---
|
||
|
||
# WS-Maint 工作区文档润色
|
||
|
||
## 什么时候使用
|
||
|
||
当用户发送包含以下模式的消息时，此技能自动触发：
|
||
|
||
| 触发词 | 行为 | 示例 |
|
||
|--------|------|------|
|
||
| `润色 + 路径/关键词` | 润色指定文档 | "润色 10.项目/11-墨犬/xxx.md" |
|
||
| `/润色 + 路径/关键词` | 同上 | "/润色 虚幻5.6" |
|
||
|
||
**只处理 `.md` 文件**
|
||
|
||
## 工作流程
|
||
|
||
> ⚠️ **必须严格按照以下顺序执行，同步是第一步！**
|
||
|
||
```
|
||
步骤1: 全量同步 NAS → 本地
|
||
↓
|
||
步骤2: 解析文档路径（支持模糊搜索）
|
||
↓
|
||
步骤3: 读取文档内容
|
||
↓
|
||
步骤4: AI 全面润色（格式 + 语言 + 结构）
|
||
↓
|
||
步骤5: 预览确认
|
||
↓
|
||
步骤6: 写入润色后内容
|
||
↓
|
||
步骤7: 全量同步 本地 → NAS
|
||
↓
|
||
步骤8: 汇报完成
|
||
```
|
||
|
||
---
|
||
|
||
## 步骤 1: 全量同步（必须先执行）
|
||
|
||
> ⚠️ **这是第一步，不能跳过！必须先同步再进行任何操作**
|
||
|
||
```bash
|
||
rclone sync "nas-webdav:/home/Drive/工作区/张青/工作区/" ~/work/zq/ \
|
||
--exclude ".git/" --exclude ".gitignore"
|
||
```
|
||
|
||
等待同步完成后再继续。
|
||
|
||
---
|
||
|
||
## 步骤 2: 解析文档路径
|
||
|
||
用户输入可能是：
|
||
- 完整路径：`10.项目/11-墨犬/A.草稿/虚幻5.6.md`
|
||
- 部分路径：`11-墨犬/虚幻5.6`
|
||
- 关键词：`虚幻5.6`
|
||
|
||
**处理逻辑**：
|
||
1. 如果是完整路径且文件存在 → 直接使用
|
||
2. 如果是部分路径或关键词 → 模糊搜索
|
||
|
||
**模糊搜索命令**：
|
||
```bash
|
||
find ~/work/zq -name "*.md" | grep -i "[关键词]"
|
||
```
|
||
|
||
如果找到多个匹配，列出供用户选择。如果只找到一个，直接使用。
|
||
|
||
**只处理 `.md` 文件**，其他类型汇报并退出。
|
||
|
||
---
|
||
|
||
## 步骤 3: 读取文档内容
|
||
|
||
使用 `read` 工具读取文件内容。
|
||
|
||
---
|
||
|
||
## 步骤 4: AI 全面润色
|
||
|
||
### 润色范围
|
||
|
||
| 方面 | 说明 |
|
||
|------|------|
|
||
| **格式规范化** | 标题层级、列表格式、代码块、表格、引用 |
|
||
| **语言润色** | 语句通顺、术语统一、消除口语化、修正错别字 |
|
||
| **结构优化** | 拆分过长段落、调整章节顺序、添加必要的章节编号 |
|
||
| **Obsidian 支持** | 保留现有 tags，没有才生成合适的 tags |
|
||
|
||
### 润色提示词
|
||
|
||
在润色时，遵循以下原则：
|
||
|
||
```
|
||
你是一个专业的技术文档润色助手。请对以下 Markdown 文档进行全面润色：
|
||
|
||
## 润色要求
|
||
|
||
### 1. 格式规范化
|
||
- 标题层级清晰（H1 > H2 > H3，不跳级）
|
||
- 列表格式统一（使用 - 或 1. 2. 3.）
|
||
- 代码块标注语言类型
|
||
- 表格对齐
|
||
- 链接格式正确
|
||
|
||
### 2. 语言润色
|
||
- 语句通顺，消除语病
|
||
- 术语统一（如：iOS 不是 IOS）
|
||
- 减少口语化表达
|
||
- 修正错别字和标点
|
||
|
||
### 3. 结构优化
|
||
- 拆分过长的段落（超过5行考虑拆分）
|
||
- 添加必要的章节编号（如：一、二、三 或 1.1、1.2）
|
||
- 添加分隔线（---）分隔大章节
|
||
- 在文档开头添加简要说明（如果原文没有）
|
||
|
||
### 4. Obsidian 支持
|
||
- 检查是否已有 frontmatter 中的 tags
|
||
- **如果已有 tags，保留不变**
|
||
- **如果没有 tags，根据内容生成 3-7 个合适的 tags**
|
||
- tags 格式：`tags: [tag1, tag2, tag3]`
|
||
|
||
### 5. 保持原意
|
||
- 不改变原文的核心内容和观点
|
||
- 不删除重要信息
|
||
- 保留原文中的图片链接和引用
|
||
|
||
请输出润色后的完整 Markdown 内容。
|
||
```
|
||
|
||
### 大文件分段润色
|
||
|
||
如果文档超过 **5000 字**（约 200 行），采用分段润色：
|
||
|
||
1. 按章节分割文档
|
||
2. 逐章节润色
|
||
3. 合并润色结果
|
||
4. 检查章节间的连贯性
|
||
|
||
分段时向用户汇报进度。
|
||
|
||
---
|
||
|
||
## 步骤 5: 预览确认
|
||
|
||
> ⚠️ **必须等待用户确认后再保存**
|
||
|
||
展示改动要点摘要：
|
||
|
||
```
|
||
📄 文档：[文件名]
|
||
|
||
📋 改动预览：
|
||
- 格式：[具体改动]
|
||
- 结构：[具体改动]
|
||
- 语言：[具体改动]
|
||
- Tags：[保留现有/新生成]
|
||
|
||
确认润色？(y/n)
|
||
```
|
||
|
||
**等待用户回复**：
|
||
- `y` / `yes` / `确认` / `好` → 继续步骤 6
|
||
- `n` / `no` / `取消` / `不要` → 退出，不做修改
|
||
- 其他回复 → 询问是否确认
|
||
|
||
---
|
||
|
||
## 步骤 6: 写入润色后内容
|
||
|
||
使用 `write` 工具写入文件。
|
||
|
||
---
|
||
|
||
## 步骤 7: 全量同步到 NAS
|
||
|
||
```bash
|
||
rclone sync ~/work/zq/ "nas-webdav:/home/Drive/工作区/张青/工作区/" \
|
||
--exclude ".git/" --exclude ".gitignore"
|
||
```
|
||
|
||
---
|
||
|
||
## 步骤 8: 汇报完成
|
||
|
||
```
|
||
✅ 文档润色完成
|
||
|
||
📄 文件：[路径]
|
||
📊 改动：[格式/结构/语言/tags 的改动摘要]
|
||
📁 已同步到 NAS
|
||
```
|
||
|
||
---
|
||
|
||
## 异常处理
|
||
|
||
| 情况 | 处理方式 |
|
||
|------|----------|
|
||
| 文件不存在 | 汇报"未找到文件"，列出可能的匹配 |
|
||
| 非 .md 文件 | 汇报"只支持 .md 文件" |
|
||
| 文件被锁定 | 汇报"文件可能正在被编辑"，稍后重试 |
|
||
| 同步失败 | 汇报错误信息，不继续操作 |
|
||
| 润色失败 | 汇报错误，保留原文件不变 |
|
||
|
||
**遇到任何问题都要汇报，不要强行操作。**
|
||
|
||
---
|
||
|
||
## 示例对话
|
||
|
||
### 示例 1：完整路径
|
||
|
||
```
|
||
用户：润色 10.项目/11-墨犬/MAC+IOS平台开发/虚幻5.6 IOS平台使用源码引擎打包.md
|
||
|
||
助手：正在从 NAS 同步...
|
||
同步完成
|
||
找到文件，正在读取...
|
||
正在润色...
|
||
|
||
📄 文档：虚幻5.6 IOS平台使用源码引擎打包.md
|
||
|
||
📋 改动预览：
|
||
- 格式：添加章节编号（一~十一）、规范代码块语言标注
|
||
- 结构：拆分 2 个过长段落、添加分隔线
|
||
- 语言：修正 "IOS" → "iOS"，统一术语
|
||
- Tags：保留现有 [UE5, iOS, 打包, macOS, Xcode, Apple开发者, 源码引擎]
|
||
|
||
确认润色？(y/n)
|
||
|
||
用户：y
|
||
|
||
助手：正在保存...
|
||
正在同步到 NAS...
|
||
|
||
✅ 文档润色完成
|
||
📄 文件：10.项目/11-墨犬/MAC+IOS平台开发/虚幻5.6 IOS平台使用源码引擎打包.md
|
||
📁 已同步到 NAS
|
||
```
|
||
|
||
### 示例 2：关键词搜索
|
||
|
||
```
|
||
用户：润色 虚幻5.6
|
||
|
||
助手：正在从 NAS 同步...
|
||
同步完成
|
||
搜索匹配文件...
|
||
|
||
找到 1 个匹配：
|
||
10.项目/11-墨犬/MAC+IOS平台开发/虚幻5.6 IOS平台使用源码引擎打包.md
|
||
|
||
正在读取...
|
||
...
|
||
```
|
||
|
||
### 示例 3：多个匹配
|
||
|
||
```
|
||
用户：润色 11-墨犬/虚幻
|
||
|
||
助手：正在从 NAS 同步...
|
||
同步完成
|
||
搜索匹配文件...
|
||
|
||
找到 3 个匹配：
|
||
1. 10.项目/11-墨犬/MAC+IOS平台开发/虚幻5.6 IOS平台使用源码引擎打包.md
|
||
2. 10.项目/11-墨犬/A.草稿/虚幻5.6 IOS平台使用源码引擎打包.md
|
||
3. 10.项目/11-墨犬/A.草稿/虚幻5.6 IOS平台使用源码引擎打包_副本.md
|
||
|
||
请选择要润色的文件（输入序号 1-3）：
|
||
|
||
用户：1
|
||
|
||
助手：已选择文件 1
|
||
正在读取...
|
||
...
|
||
```
|