Menü
按项目规范撰写新文档页。当用户说"写文档"、"新建文档"、"添加文档"、"写一篇文档"时使用此技能。
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Basierend auf der SOC-Berufsklassifikation
| name | doc-writer |
| description | 按项目规范撰写新文档页。当用户说"写文档"、"新建文档"、"添加文档"、"写一篇文档"时使用此技能。 |
| argument-hint | <模块/路径> [标题] |
| allowed-tools | Read, Grep, Glob, Bash, Edit, Write, Agent |
你是文档撰写助手，负责按照项目规范为 RuoYi-Plus-UniApp 创建高质量技术文档。
$ARGUMENTS 格式：<模块/路径> [标题]
backend/common/新模块 数据加密模块frontend/components/新组件mobile/wd/form/新组件 评分组件practices/backend/新实践D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-docsD:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflowdocs/.vitepress/config.ts根据路径前缀判断文档类型：
| 路径前缀 | 文档类型 | 模板 |
|---|---|---|
backend/ | 后端模块文档 | 后端模板 |
frontend/components/ | 前端组件文档 | 组件模板 |
frontend/ | 前端通用文档 | 通用模板 |
mobile/wd/ | WD UI 组件文档 | WD 组件模板（使用 component-doc 技能） |
mobile/ | 移动端通用文档 | 通用模板 |
practices/ | 最佳实践文档 | 实践模板 |
读取 CLAUDE.md 中以下部分：
ls "D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-docs/docs/<目标目录>/"
读取同目录下 1-2 个已有文档，学习其风格和结构。
如果文档涉及具体源码实现：
参考: src/path/to/file.ext:行号）根据文档类型使用对应模板：
# 模块名称
## 概述
简要说明模块功能和用途。
## 核心特性
- 特性 1
- 特性 2
## 快速开始
### 引入依赖
### 基本配置
### 使用示例
## API 参考
### 核心类/接口
| 类名 | 说明 | 参考 |
|------|------|------|
| `XxxService` | 描述 | `参考: src/path:行号` |
### 配置项
| 配置键 | 类型 | 默认值 | 说明 |
|--------|------|--------|------|
## 最佳实践
## 常见问题
# 组件名称
## 概述
## 基础用法
## 组件属性 (Props)
| 属性 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
## 事件 (Events)
| 事件名 | 参数 | 说明 |
|--------|------|------|
## 插槽 (Slots)
| 插槽名 | 参数 | 说明 |
|--------|------|------|
## 代码示例
### 示例 1: 基础用法
### 示例 2: 进阶用法
## 最佳实践
## 常见问题
# 标题
## 背景
为什么需要这个实践。
## 核心原则
## 实践指南
### 步骤 1
### 步骤 2
## 代码示例
## 注意事项
## 参考资料
撰写完成后自检：
Result<T>，不是 Result<T>）参考: src/path/to/file.ext:行号）## 文档已创建
- **文件**: `docs/<路径>/<文件名>.md`
- **类型**: <文档类型>
- **字数**: <约 N 字>
> 💡 提示：需要将新文档添加到侧边栏，请使用 `/sidebar` 命令
产品矩阵同步。当用户说"同步产品"、"添加产品"、"更新产品"、"产品引流"、"sync products"时使用此技能。管理所有产品信息并同步到各文档站点，实现互相引流。
自动生成更新日志。当用户说"生成更新日志"、"changelog"、"版本记录"、"更新记录"时使用此技能。
WD UI 组件文档专用生成器。当用户说"写组件文档"、"WD组件"、"组件文档"时使用此技能。
文档质量审查，检查准确性、规范性、完整性。当用户说"审查文档"、"检查文档质量"、"review"时使用此技能。
跨模块文档内容搜索与引用分析。当用户说"搜索文档"、"哪些文档提到"、"查找文档"时使用此技能。
文档覆盖率统计与健康报告。当用户说"文档统计"、"覆盖率"、"文档状态"、"stats"时使用此技能。