README 与 API 文档

让读者，
第一次就跑通。

版本号、命令、参数一个字不动。评审文档结构、示例一致性与前提说明，输出可执行的改进清单与修订稿——无法确认的接口细节会标出来交给你。

版本不动示例可跑写明前提

审阅评审结果

结果会显示在这里

系统将检查文档结构、示例与签名是否一致、前提是否写明，并列出待确认项。

示例结果

你会拿到的输出，长这样。

下面是对上方演示原文的完整输出示例：结构评分、逐条改进说明、待确认的接口细节，以及修订后的文档。示例为演示用途，不是客户案例。

示例

评审结果（示例）

结构评分88/100

+50

补上环境要求与快速开始

原文直接进入安装与使用，读者不知道需要什么环境。补充环境要求章节，并把示例整理成可复制的快速开始代码块。

把未说明的参数标为待确认

示例里出现 fuzzy 参数，但文档全文未说明其取值与默认值。标为 TODO，由你决定补充文档还是移除该参数。

补充失败模式与限制

原文没有说明常见错误与使用上限。加入失败模式与限制章节，并把需要确认的实际错误类型与返回上限留成 TODO。

修订后的文档

# sdk

调用检索接口的 Node.js SDK。

## 环境要求

Node.js 18 及以上。TODO：确认最低支持版本。

## 安装

```bash
npm install our-sdk
```

## 快速开始

```js
import { Client } from "our-sdk";

const client = new Client({ key: process.env.SDK_KEY });
const result = await client.search({ q: "hello", limit: 10 });
```

TODO：`fuzzy` 参数在上例中出现，但本文档未说明其取值与默认值，需确认后补充或移除。

## 失败模式

- 密钥缺失时构造 Client 会抛错。TODO：确认实际错误类型并补全。

## 限制

单次检索最多返回 TODO 条结果。

评审做什么

不是润色，是检查读者会不会卡住。

第一次成功要够快

读者决定要不要继续用，往往取决于前十分钟。最小可运行示例与安装命令必须清楚。

示例必须和签名一致

示例里用了文档别处没写的参数，是最常见也最伤人的文档 bug。

前提与失败模式要写明

需要什么环境、不支持什么、最容易先撞到哪个错误——不写，读者就只能自己试。

为什么值得做

文档是产品的一部分，不是附属品。

上手失败就流失

多数开发者放弃一个库，是因为前十分钟没跑通，而不是因为功能不够。

示例漂移最难发现

代码更新了文档没更新，示例里的参数早已不存在。这类问题只有逐字比对才能发现。

不写边界等于埋雷

不支持的场景不说明，用户会在生产环境里自己撞上，然后写差评。

说明：文档质量没有统一评分标准。本站依据通用实践检查：是否可快速上手、示例与签名是否一致、前提与失败模式是否写明。这不构成对代码正确性或 API 设计的评审。

改写演示

同一份 README，两种写法。

评审前

# sdk 简单的 SDK，用于调用我们的接口。 ## 安装 npm install our-sdk ## 使用 const client = new Client({ key: 'xxx' }) const result = await client.search({ q: 'hello', limit: 10, fuzzy: true }) 更多详见文档站。

修订后

# sdk

调用检索接口的 Node.js SDK。

## 环境要求

Node.js 18 及以上。TODO：确认最低支持版本。

## 安装

```bash
npm install our-sdk
```

## 快速开始

```js
import { Client } from "our-sdk";

const client = new Client({ key: process.env.SDK_KEY });
const result = await client.search({ q: "hello", limit: 10 });
```

TODO：`fuzzy` 参数在上例中出现，但本文档未说明其取值与默认值，需确认后补充或移除。

## 失败模式

- 密钥缺失时构造 Client 会抛错。TODO：确认实际错误类型并补全。

## 限制

单次检索最多返回 TODO 条结果。

演示样例：补齐环境要求与快速开始、把示例改成可复制的代码块、把文档未说明的 fuzzy 参数标为待确认。在工作台提交你的文档即可得到针对你的版本（需登录，每次消耗 1 次额度）。

为什么可以放心

我们把“不动版本号”写进了产品原则。

版本与命令零改动

Node 版本、依赖名、安装命令、参数名一律原样保留。需要确认的写成 TODO，不替你猜。

不执行也不验证代码

我们不编译、不运行你的代码片段。代码是否真的能跑，仍由你负责。

示例不一致会指出而非修改

示例用了文档别处没写的参数时，我们标出来让你决定补文档还是改示例，不悄悄改。

正文不留存

提交的内容仅用于本次 AI 处理，本站不主动保存正文；详见隐私政策。

常见问题

付费前，你可能想问。

会改我的版本号吗？

不会。版本号、依赖名、命令、参数名、代码标识符一律原样保留。需要确认的写成 TODO。

会验证代码能跑吗？

不会。我们不编译也不运行代码片段，只检查文档结构与示例和签名是否一致。

能直接改我的文件吗？

不能。输出是 Markdown 修订稿，由你决定怎么合并进仓库。

一次评审消耗什么？耗时多久？

一次评审消耗 1 次额度，通常十几秒完成，输出修订稿、改进说明与待确认项。

额度会过期吗？

不会。额度永不过期，本次没用完的部分会自动累积到下一次，不会清零。

支持批量处理或 API 吗？

目前每次处理一篇内容，不提供批量上传或 API，额度按次消耗。如你有大量自动化需求，请先邮件说明场景。

我的内容会被保存吗？

不会主动保存。正文仅用于本次 AI 处理，详见隐私政策。

适合哪些文档？

README、快速开始、API 参考、SDK 使用说明、内部工具文档——任何希望读者第一次就跑通的技术文档。

简单透明的价格

先验证价值，再决定是否升级。

Starter

$9/ 月

适合发布频率较低的轻量使用者。

50 次优化额度，每月续费发放
完整 GEO 分析
中英文输出
Markdown 导出

Pro

Advanced

$79/ 月

含最高月度额度，适合最高频的深度使用者。

1,000 次优化额度，每月续费发放
完整 GEO 分析
中英文输出
Markdown 导出

额度永不过期：未用完的额度会累积到下一次，不会清零。额度仅在当前站点有效，不与其他站点通用。

标价为美元基准价；最终币种、税费与折扣由 Paddle 按结账所在地确定。