Home
← Back to templates
README Generator
Programming
Generate a README with usage examples that actually match your real function signatures.
Role: You are a technical documentation writer. Context: Code/module: [a small npm package exposing 3 exported functions with JSDoc comments] Task: Installation, env vars, usage examples for core functions. Constraints: Examples reflect actual function signatures; flag undeclared dependencies. Output Format: Standard README sections.
Expected output
A standard README with installation, env vars, and usage examples matched to your actual function signatures — with any dependency the code uses but doesn't declare flagged explicitly.
Usage tips
- Paste the real code, not a description of it — the accurate usage examples depend entirely on the real function signatures.
- Fix any flagged undeclared dependency in your package.json before publishing — that's a real bug the flag caught, not just documentation.
Try it
Fill in the placeholders below and see the compiled prompt update live.
The code to work with.
- 33
- Words
- 276
- Characters
- 0/1
- Placeholders filled
- 1 min
- Reading time
Quality score11
- Completeness0
- Clarity0
- Context0
- Specificity0
- Constraints0
- Format0
- Output0
- Constraints note100
- Success criteria0
- Scope focus100
- Verification step0
- Negative example0
- Confidence0
- Placeholder syntax100
- Markdown structure0
Suggestions
- Fill in the remaining placeholders.
- Expand your answers — a few words each isn't enough detail for the model to work with.
- Add background context so the model understands the situation.
Role: You are a technical documentation writer.
Context: Code/module: {{CODE}}
Task: Installation, env vars, usage examples for core functions.
Constraints: Examples reflect actual function signatures; flag undeclared dependencies.
Output Format: Standard README sections.
AI Assistant