Questions tagged [documentation]
Post a PromptPrompts that produce docs, READMEs, and comments.
7 prompts
35votes
1answers
3.4kviews
Prompt that generates an API reference from OpenAPI with realistic examples, not {string}
Generated API docs always have example values like "string", 0, true. Useless. Developers copy them and immediately hit validation errors. I feed the model the OpenAPI schema and force it to invent do
18votes
1answers
2.2kviews
Prompt for docstrings that document the WHY and the gotchas, not just the params
Auto-generated docstrings are useless: they restate the function signature in English. def add(a, b): """Adds a and b.""". Thanks. I wrote a prompt that reads the function body and forces it to docume
20votes
2answers
3.1kviews
Prompt that turns a messy codebase into a README people actually finish reading
Our README was the usual wall: a paragraph of marketing, then npm install, then nothing. New hires bounced off it constantly. What finally worked was forcing the model to write for one specific reader
9votes
2answers
1.8kviews
Prompt to convert a messy research notebook into a reproducible, parameterized script
My analysis lived in a 400-cell notebook with out-of-order execution, hardcoded paths from my laptop, and df reused for six different frames. It ran on my machine and nowhere else. I needed a clean CL
12votes
0answers
1.4kviews
Prompt for a changelog that a non-engineer can actually read, grouped by impact
Our raw changelog was just squashed commit subjects. Customers ignored it because it was 40 lines of refactor(api): ... that meant nothing to them. I now generate two changelogs from the same merged P
16votes
1answers
1.9kviews
Prompt for commit messages that explain WHY, generated from a diff
My commit history was a graveyard of "fix", "update", "wip". Reviewing my own PRs a month later was archaeology. I wired a prompt into a pre-commit hook that reads the staged diff and drafts a Convent
12votes
1answers
1.2kviews
Prompt for release notes that read like a human wrote them, tone-matched to the product
Our release notes swung between robotic ("Bumped dependency versions") and try-hard ("We've been cooking up something special"). Neither felt like us. I built a prompt that takes a tone sample from ou