Mark the unstated purpose as still needed
The source only says “helps teams organise documents”. That stays, with an explicit note that target users and typical scenarios must still be supplied.
Project info into a README
Say what it does.
And what it does not.
Turn project notes, feature lists, and scattered explanations into a README: purpose, installation, usage, limits, and contributing. No invented capabilities, dependencies, commands, licences, performance figures, or compatibility claims; gaps become placeholders listed for verification.
No invented featuresGaps as placeholdersLimits required
02
Review the README
Your result will appear here
We write purpose and limits first, then installation and usage, leave placeholders for what is missing, and list every fact you need to confirm.
SAMPLE OUTPUT
Here is exactly what you receive.
This is the complete output for the source text in the demo above: a completeness score, itemised revision notes, what became a placeholder or an item to verify and why, and the drafted README. It is a demonstration, not a customer case.
SAMPLE
README result (sample)
Completeness score88/100
+50
Turn installation and usage into placeholders
“Install the dependencies and it runs” is not an installation section. It becomes a placeholder listing the package manager, commands, and environment requirements still missing.
Demote the unsupported claims
“All kinds of formats” and “fast” have no list and no measurements. They move into the supported scope and performance sections as items to verify.
Drafted README
# Project name [to be filled] ## What this is A tool that helps teams organise documents. The specific problem it solves and its audience are still to be supplied. TODO: the source does not name the target users or typical use cases ## Installation [to be filled: installation steps] TODO: the source only says “install the dependencies and it runs”; no package manager, command, or environment requirement is given ## Usage [to be filled: basic usage example] TODO: no command, configuration, or call example in the source ## Supported scope To verify: the source says “all kinds of formats” without listing them ## Limits - To be supplied: capabilities not currently supported and known constraints ## Performance To verify: the source says “fast” with no measurements ## Licence Unspecified: the source does not mention a licence; the maintainer must decide ## Contributing Pull requests are welcome. TODO: add the contribution process, code style, and review requirements
WHAT DRAFTING DOES
A README is a promise, not an advertisement.
State the problem first
The first screen answers “what is this and who is it for”. Readers will not dig to paragraph three to find the purpose.
Never guess install commands
A plausible command that fails is worse than a visible gap that says it needs filling.
Limits get their own section
Writing down what is unsupported or unfinished makes a project easier to trust and to adopt.
WHY IT IS WORTH DOING
One wrong line in a README costs a user an hour.
A broken install command drives people away
If the first step fails, most people do not try twice and do not tell you what went wrong.
Invented features become demands
Users go looking for a capability you wrote down; when it is missing they file it as a bug.
The licence cannot be guessed
The licence decides whether others may use the code at all. When it is unknown, say unspecified and let the maintainer choose.
Note: common practice for READMEs is to lead with purpose and audience, follow with installation and usage, and close with limits and how to contribute. Communities differ on section order and depth. This site drafts documents only; it reads no repository code and offers no legal opinion or compatibility guarantee.
DRAFTING DEMO
The same project description, organised.
Before
We built a project that helps teams organise documents. It is very easy to use and fast, and supports all kinds of formats. Install the dependencies and it runs, how exactly depends. Anyone interested can join in, PRs are welcome.
Drafted
# Project name [to be filled] ## What this is A tool that helps teams organise documents. The specific problem it solves and its audience are still to be supplied. TODO: the source does not name the target users or typical use cases ## Installation [to be filled: installation steps] TODO: the source only says “install the dependencies and it runs”; no package manager, command, or environment requirement is given ## Usage [to be filled: basic usage example] TODO: no command, configuration, or call example in the source ## Supported scope To verify: the source says “all kinds of formats” without listing them ## Limits - To be supplied: capabilities not currently supported and known constraints ## Performance To verify: the source says “fast” with no measurements ## Licence Unspecified: the source does not mention a licence; the maintainer must decide ## Contributing Pull requests are welcome. TODO: add the contribution process, code style, and review requirements
Demo sample: “all kinds of formats” and “fast” become items to verify, missing install and usage steps stay as placeholders instead of invented commands, and the licence reads as unspecified. Paste your project info to get your version (sign-in required; one credit per run).
WHY YOU CAN TRUST IT
We put “no invented capabilities” into our product principles.
Features you never wrote stay out
Capabilities, dependencies, and commands absent from your notes become placeholders rather than filler that makes the document look finished.
The licence is never guessed
When no licence is mentioned, it reads as unspecified and goes on the verification list. Only the maintainer can decide it.
No numbers for performance or compatibility
Speed claims, compatibility statements, and support promises without measurements are withheld and listed as things to confirm.
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 fill in the missing install commands?
No. Install commands, dependencies, and environment requirements become placeholders and go on the verification list. A command that fails is more harmful than a gap that says so.
What if no licence is mentioned?
It reads as unspecified and is listed for verification. The licence decides whether others can use the code, so only the maintainer can choose it.
How do you handle claims like “fast” or “supports many formats”?
They are kept out of the body text. Each becomes an item to verify, noting that a format list or measurements are needed before it can go into a README.
What does one draft cost?
One credit per run, usually done in seconds, returning the README, revision notes, and items to verify.
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.
What content fits?
A first README for a new project, notes prepared before open-sourcing an internal tool, a repository with only a feature list, a verbal project introduction — any project information that needs to become a real README.
SIMPLE PRICING
Prove the value before you upgrade.
Starter
$9/ monthFor 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/ monthFor frequent publishers who iterate on content continuously.
- 250 optimization credits per monthly renewal
- Complete GEO analysis
- Chinese and English output
- Markdown export
Advanced
$79/ monthOur 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
Loading localized prices
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.