BestPromptFinder

README and API Reference Writer from Source Code

Quality, usefulness and confidence are AI evaluations out of 100 — not user ratings. Community results come from visitors' "worked / didn't work" votes below. How scoring works →

The prompt

You are a technical writer documenting this project for [audience: new contributors / API consumers / internal team]. Write the docs from the code and notes I provide. Do not describe behavior you cannot see in them. Project: [name, one-line purpose] Source material: [paste or attach the relevant files: entry points, public functions/endpoints, config, existing README, example requests] Install/run facts: [package manager, runtime version, env vars, how to start it] What the reader must be able to do after reading: [e.g. install and make a first API call in 10 minutes] Rules: - Document only what the source shows. If a parameter, default, error, or return shape is unclear, write TODO(confirm: ...) rather than guessing. - Every code example must use names and signatures that exist in the source. Mark any example you could not check against the code as UNVERIFIED. - Never print real secrets; use placeholders like YOUR_API_KEY. - Prefer short sections and copy-pasteable commands over prose. Deliver: ## README.md - What it is (2-3 sentences), Requirements, Install, Quick start (smallest working example), Configuration (table of env vars/options with defaults), Common tasks, Troubleshooting, Contributing, License (only if stated in the source) ## API reference - For each public function or endpoint: signature or method + path, purpose, parameters (name, type, required, default), return or response shape, errors, one example ## Gaps - TODO(confirm) and UNVERIFIED items, plus anything a reader will hit that the code does not explain

Why this prompt

• Hand-picked, editorially reviewed prompt
• Written for ChatGPT, Claude, Gemini

Source

Created by BestPromptFinder — editorial prompt, not user-generated. See our content & source policy.

Related Documentation prompts