README and API docs

Help the reader succeed
on the first try.

Version numbers, commands, and parameters are left untouched. We review structure, example consistency, and prerequisites, then return an actionable fix list and a revised draft — with interface details we cannot confirm marked for you.

Versions untouchedRunnable examplesState prerequisites

Review the result

Your result will appear here

We check structure, whether examples match the documented signatures, and whether prerequisites are stated, then list what needs confirming.

SAMPLE OUTPUT

Here is exactly what you receive.

This is the complete output for the source text in the demo above: a structure score, itemised fixes, interface details to confirm, and the revised documentation. It is a demonstration, not a customer case.

SAMPLE

Review result (sample)

Structure score88/100

+50

Add requirements and a quick start

The source jumped straight to install and usage with no environment stated. A requirements section is added and the example becomes a copyable quick-start block.

Flag the undocumented parameter

The example passes `fuzzy`, which appears nowhere else in the document. It is marked TODO so you can document the option or remove it from the example.

Add failure modes and limits

The source documented neither common errors nor usage ceilings. Both sections are added, with the actual error type and result cap left as TODO.

Revised documentation

# sdk

A Node.js SDK for the search API.

## Requirements

Node.js 18 or newer. TODO: confirm the minimum supported version.

## Install

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

## Quick start

```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: the `fuzzy` option appears in the example but is documented nowhere in this file — confirm its values and default, then document it or remove it.

## Failure modes

- Constructing a Client without a key throws. TODO: confirm the actual error type.

## Limits

A single search returns at most TODO results.

WHAT THE REVIEW DOES

Not polishing. Checking where readers get stuck.

First success must be fast

Whether someone keeps using a library is usually decided in the first ten minutes. The minimal working example and install command have to be unambiguous.

Examples must match signatures

An example using a parameter documented nowhere else is the most common and most damaging documentation bug.

Prerequisites and failure modes belong on the page

What environment is needed, what is unsupported, and which error a reader hits first — if it is not written, they find out the hard way.

WHY IT IS WORTH DOING

Documentation is part of the product, not an accessory.

Onboarding failure loses users

Most developers drop a library because the first ten minutes failed, not because it lacked features.

Example drift is hard to spot

Code ships, docs do not, and the example still passes a parameter that no longer exists. Only a line-by-line comparison catches it.

Unstated limits are buried bugs

If unsupported cases are not documented, users hit them in production and write the review.

Note: there is no universal scoring standard for documentation quality. This site applies common practice: can a reader get started quickly, do examples match signatures, are prerequisites and failure modes stated. It is not a review of code correctness or API design.

REWRITE DEMO

One README, two versions.

Before

# sdk A simple SDK for calling our API. ## Install npm install our-sdk ## Usage const client = new Client({ key: 'xxx' }) const result = await client.search({ q: 'hello', limit: 10, fuzzy: true }) See the docs site for more.

Revised

# sdk

A Node.js SDK for the search API.

## Requirements

Node.js 18 or newer. TODO: confirm the minimum supported version.

## Install

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

## Quick start

```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: the `fuzzy` option appears in the example but is documented nowhere in this file — confirm its values and default, then document it or remove it.

## Failure modes

- Constructing a Client without a key throws. TODO: confirm the actual error type.

## Limits

A single search returns at most TODO results.

Demo sample: requirements and a quick start are added, the example becomes a copyable code block, and the undocumented fuzzy option is flagged. Paste your documentation to get your version (sign-in required; one credit per run).

WHY YOU CAN TRUST IT

We put “never touch version numbers” into our product principles.

Versions and commands never move

Node versions, dependency names, install commands, and parameter names stay verbatim. Anything uncertain becomes TODO rather than a guess.

We do not run your code

Snippets are neither compiled nor executed. Whether the code actually runs remains your responsibility.

Inconsistencies are flagged, not silently fixed

When an example uses an undocumented parameter, we surface it so you decide whether to document it or drop it.

Content is not stored

Submitted text is used for this single AI request and is not intentionally persisted. See the Privacy Policy.

FAQ

Ask these before you pay.

Will you change my version numbers?

No. Version numbers, dependency names, commands, parameter names, and code identifiers are kept verbatim. Uncertain items become TODO.

Do you verify the code runs?

No. We neither compile nor execute snippets. We check documentation structure and whether examples match the documented signatures.

Can you edit my files directly?

No. Output is a Markdown revision you decide how to merge into the repository.

What does one review cost?

One credit per run, usually done in seconds, returning the revision, the fix list, and items to confirm.

Do credits expire?

No. Credits never expire — whatever you do not use carries over to the next cycle instead of resetting.

Is there batch processing or an API?

Not yet. Each run processes one document and consumes one credit; there is no bulk upload or API today. Email us with your use case and we will assess it.

Is my content stored?

Not intentionally. Text is used for this single AI request only. See the Privacy Policy.

Which documents fit?

READMEs, quick starts, API references, SDK guides, internal tool docs — anything a reader should get working on the first attempt.

SIMPLE PRICING

Prove the value before you upgrade.

Starter

$9/ month

For an occasional publishing cadence, with a focused monthly credit allocation.

50 optimization credits per monthly renewal
Complete GEO analysis
Chinese and English output
Markdown export

Pro

Recommended$29/ month

For frequent publishers who iterate on content continuously.

250 optimization credits per monthly renewal
Complete GEO analysis
Chinese and English output
Markdown export

Advanced

$79/ month

Our largest monthly credit allocation, for the heaviest continuous usage.

1,000 optimization credits per monthly renewal
Complete GEO analysis
Chinese and English output
Markdown export

Credits never expire: unused credits carry over instead of resetting. Credits apply to this site only and are not shared with other sites.

Prices shown are USD baselines; final currency, taxes, and discounts are determined by Paddle for the checkout location.