name: write-natural description: 生成更自然、更像人类撰写的技术文档。避免 AI 生成文本的典型特征:过度结构化、冗余词汇、模板化表达。当生成 README、API 文档、设计文档、技术博客时使用。
写出更自然的技术文档
生成技术文档时,遵循以下原则让内容更自然。
核心原则
- 删比写重要 - 写完后删掉 30% 的修饰词
- 别总列清单 - 不是所有内容都要拆成要点
- 直接说 - 跳过"首先让我们了解"这类铺垫
- 敢下结论 - 别用"可能"、"或许"回避观点
- 口语化 - 技术文档也可以像聊天一样
禁用词汇表
写作时主动避开这些词,它们是 AI 味的主要来源:
连接词(直接删掉或重组句子)
- 此外、另外、除此之外
- 然而、不过、但是(连续使用时)
- 因此、所以、综上所述
- 值得注意的是、需要指出的是
- 首先...其次...最后...
强调词(通常是废话)
- 非常、极其、十分
- 至关重要、非常重要
- 确保、务必、一定要
- 关键、核心、本质上
模板句式(整句删掉)
- "在开始之前,让我们先了解..."
- "总的来说..."、"综上所述..."
- "接下来,我们将..."
- "正如我们所看到的..."
正反例对比
例 1:项目介绍
AI 风格:
本项目是一个非常强大的命令行工具,它可以帮助开发者高效地管理他们的配置文件。首先,它支持多种格式;其次,它提供了直观的命令接口;最后,它具有出色的扩展性。
人类风格:
一个管理配置文件的命令行工具。支持 YAML、JSON、TOML,命令简单,可以写插件扩展。
例 2:安装说明
AI 风格:
在开始使用本工具之前,您需要确保您的系统满足以下前置条件。首先,请确保您已经安装了 Node.js 18 或更高版本。您可以通过运行以下命令来验证您的 Node.js 版本:
人类风格:
需要 Node.js 18+。
npm install -g mytool
例 3:功能说明
AI 风格:
此外,本系统还提供了一个非常重要的缓存功能。通过使用这个功能,用户可以显著提升查询性能。值得注意的是,缓存默认是关闭的,需要在配置文件中手动启用。
人类风格:
有缓存功能,能加快查询。默认关闭,在配置里开:
cache: true
检查清单
写完文档后快速过一遍:
- 删掉了"首先、其次、最后"?
- 没有"综上所述"、"总的来说"?
- 强调词(非常、至关重要)删干净了?
- 列表不超过 5 项?超过就考虑分组或写成段落
- 开头直接说主题,没有铺垫?
更多参考
- AI 文本的详细特征分析:ai-patterns.md
- 人类写作风格指南:human-style.md