验道

Skills/doc-polish

技术文档润色

入门写作沟通

把草稿改成结构清楚、可直接发布的中文技术说明。

预估消耗
约 1k–4k / 次
推荐模型
claude-sonnet-4-20250514
标签
docswriting

使用步骤

  1. 提供目标读者（同事 / 外部用户）与文档用途
  2. 粘贴草稿，要求保留原意、不编造接口
  3. 人工核对命令与参数后再发布

Prompt

请润色下列技术文档草稿（中文）：

目标读者：<同事 / 外部用户>
用途：<README / 接口说明 / 操作手册>

要求：
- 保留原意，不编造未出现的接口或行为
- 结构：背景 → 步骤 → 注意点 → 常见问题
- 命令与参数用代码块
- 不确定处标「待确认」

草稿：
<粘贴内容>

Claude Code · SKILL.md

复制后保存为 ~/.claude/skills/doc-polish/SKILL.md，或项目内同名路径。可用 /doc-polish 调用。

---
name: doc-polish
description: 当用户需要润色 README、接口说明、操作手册，或把口语草稿改成文档时使用。
---

# 技术文档润色

把草稿改成结构清楚、可直接发布的中文技术说明。

## 使用步骤

1. 提供目标读者（同事 / 外部用户）与文档用途
2. 粘贴草稿，要求保留原意、不编造接口
3. 人工核对命令与参数后再发布

## 指令

请润色下列技术文档草稿（中文）：

目标读者：<同事 / 外部用户>
用途：<README / 接口说明 / 操作手册>

要求：
- 保留原意，不编造未出现的接口或行为
- 结构：背景 → 步骤 → 注意点 → 常见问题
- 命令与参数用代码块
- 不确定处标「待确认」

草稿：
<粘贴内容>