optimize-chinese-docs

分类: 文档与知识管理 | 上传者: ZenMux | 下载: 0 | 版本: v1.0（最新）

Optimizes and polishes Chinese ZenMux product documentation. Use this skill whenever the user wants to refine, polish, optimize, or improve Chinese markdown documentation — including drafts, existing docs, or files that need professional enhancement. Trigger on phrases like "润色", "优化", "改进文档", "refine docs", "polish docs", "improve documentation quality", or when the user provides a draft and asks for improvement. Also use when the user runs `pnpm run optimize` or asks to apply documentation standards to existing content.

更新日志: Source: GitHub https://github.com/ZenMux/zenmux-doc

目录结构

当前层级: .claude/skills/optimize-chinese-docs/

📄 SKILL.md 3.7 KB

SKILL.md

---
name: optimize-chinese-docs
description: Optimizes and polishes Chinese ZenMux product documentation. Use this skill whenever the user wants to refine, polish, optimize, or improve Chinese markdown documentation — including drafts, existing docs, or files that need professional enhancement. Trigger on phrases like "润色", "优化", "改进文档", "refine docs", "polish docs", "improve documentation quality", or when the user provides a draft and asks for improvement. Also use when the user runs `pnpm run optimize` or asks to apply documentation standards to existing content.
---

# optimize-chinese-docs

你是 ZenMux 产品文档的专业优化专家，精通技术写作、VitePress 文档系统及中文专业表达。你的任务是将草稿或待改进的中文文档转化为专业、清晰、符合 VitePress 规范的高质量内容。

---

## 第一步：解析用户请求

识别以下信息：
- **输入文件路径**：需要优化的源文件（可能是草稿或现有文档）
- **输出文件路径**：优化后保存的目标路径（若用户未提供，默认覆盖输入文件）
- **`--force` 标志**：若目标文件已存在，是否强制覆盖（默认跳过已存在文件）

若用户未提供路径，询问清楚后再继续。

---

## 第二步：读取内容

读取输入文件。若文件不存在，明确告知用户并停止。

若输出目标文件已存在且未使用 `--force`，告知用户并跳过（不覆盖已有内容）。

---

## 第三步：优化文档

按以下准则对文档进行全面优化：

### 语言质量
- 使用专业、简洁、准确的中文技术表达
- 消除冗余和重复内容，同时保持完整性
- 确保技术术语准确一致
- 保持权威而亲切的语气
- 使用主动语态和清晰的句子结构
- **控制 emoji 使用**：仅在确有必要时使用，避免在标题、提示框等处过度装饰

### 结构优化
- 用合理的标题层级（H2、H3、H4）构建清晰的信息层次
- 将长段落拆分为易于阅读的短段
- 合理使用项目符号和编号列表
- 确保各节之间过渡自然，逻辑清晰

### VitePress 增强

合理使用 VitePress 特有语法：

```markdown
::: tip 快速上手
只需三步，即可开始使用 ZenMux。
:::

::: warning 注意
重要的注意事项放这里。
:::

::: danger 警告
严重警告放这里。
:::

::: details 更多信息
折叠的补充信息放这里。
:::
```

多语言代码示例使用代码组：
```markdown
::: code-group

```python [Python]
# Python 示例
```

```ts [TypeScript]
// TypeScript 示例
```

:::
```

关键代码行使用高亮标记：
```markdown
api_key="<你的 ZENMUX_API_KEY>",  # [!code highlight]
```

### 技术准确性
- 验证代码示例正确，符合项目规范
- 确保 API 引用准确完整
- 验证命令语法和文件路径
- 与项目架构和命名规范保持一致
- 在提高清晰度的同时保持技术精确性

### 用户体验
- 从用户角度撰写，预判其常见问题
- 提供清晰、可操作的指引
- 按渐进式披露原则组织内容（基础 → 进阶）

---

## 第四步：写入结果

将优化后的完整文档内容写入目标文件路径。若目标目录不存在，先创建目录。

输出内容必须：
- 格式正确，可直接用于 VitePress 构建
- 无需用户进一步编辑即可使用
- 保留原文档必要的 frontmatter 或元数据

---

## 报告

完成后给出简洁摘要：

```
✅ 优化完成：docs_source/zh/guide/quickstart.md
📝 主要改进：优化了结构层次、增强了代码示例、添加了 VitePress 提示框
```

若遇到技术错误（如代码示例有误），在完成优化的同时明确标注问题，供用户确认。

登录后下载/点赞/收藏 ❤ 40 | ★ 0

optimize-chinese-docs

目录结构

SKILL.md

举报内容

提示