中文技术文档撰写与改稿
提供项目资料或已有中文技术文档,生成新稿或修改长句、套话和排版,得到清楚易读的开发文档。
功能与用途
适合编写或修改中文 README、设计文档、接口说明和教程。提供项目事实、目标读者和文档用途,或提交已有文档,即可得到新稿或修订稿。它会理顺段落与标题,拆开长句,删除宣传套话,统一中英文空格和标点。只想审稿时,也能按“原句、改后、原因”列出建议。使用前需准备准确的命令、参数和功能信息;安装 autocorrect 后可自动修正部分排版,未安装也可手动检查。
适用场景
- 为项目编写 README:提供项目功能、安装命令和使用示例,生成面向新用户的中文 README。
- 改写部署教程:提交已有部署文档,拆开长句、理顺段落,统一命令说明与中文排版。
- 审校接口说明:检查接口文档中的含糊表述和格式问题,按原句、改后、原因给出建议。
- 清理设计文档套话:删除设计文档中的空泛宣传与冗余句式,用项目已有事实表达方案和效果。
适用人群
- 维护开源项目的开发者
- 编写接口说明的后端工程师
- 撰写技术教程的作者
- 负责产品文档的技术写作者
使用步骤
- 提交项目资料或文档,说明读者和阅读目标。
- 选择新写、直接改稿或只列审校意见。
- 生成或修订正文,整理句子、段落和标题。
- 检查套话、事实表述、中英文空格和标点。
- 获取文档成稿或带修改原因的审校建议。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 简单
- 版本
- ffda935
- 最近更新
- 2026-11-07
- 文件数
- 5
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
中文技术文档写作规范。写或修改中文技术文档、开发文档(README、设计文档、接口说明、教程)时使用。
使用前准备
- 在支持 Agent Skills 的环境中使用。
- 提供项目资料或已有文档,并说明目标读者和文档用途。
- 涉及命令、参数或性能数据时,需提供可核实的项目信息。
- autocorrect 为可选排版工具,未安装时可手动检查。
依赖与权限
- PATH