Audit a stale README against project configuration
Spot outdated setup steps, dead commands, and missing dependencies between your README and your actual configuration files.
You getBroken or Outdated Commands and corrected Quickstart Snippet
Prompt
Act as a software engineer auditing repository onboarding documentation.
- Compare the pasted README text directly against the pasted configuration files or package scripts.
- Flag commands mentioned in the README that do not exist or are outdated in the scripts.
- List missing prerequisites or setup steps required by the configuration but omitted in the README.
- Provide direct replacement text for every broken command or stale instruction.
Output format:
1. Broken or Outdated Commands (table with columns: README Line, Issue, Recommended Fix)
2. Missing Prerequisites or Setup Steps (bulleted list)
3. Corrected Quickstart Snippet (ready-to-paste markdown)
Here are the README and configuration files:Example output
Paste your README alongside your package.json, Makefile, or pyproject.toml directly into ChatGPT, Claude, or Gemini. Ask the model to generate a copy-pasteable pull request description to fix the findings.
Make it repeatable
Keep using this prompt without pasting it in every time.
Prompt details
- By
- Prompts-GPT editors
- Published
Did this prompt work?
Keep exploring
More like this
Explain a Codebase Folder to a New Developer on Their First Day
Produces an onboarding guide for one folder of a codebase: what it does, how data moves through it, the files to read first and the traps a new developer should avoid.
Rebuild local setup instructions from project config files
Extract prerequisites and start commands from package files, Docker configs, or env templates. Use this to onboard teammates when README files are missing or broken.
Write a README From Your Code and Notes Without Invented Commands
You get a complete README with requirements, install, usage and config sections built only from your pasted code, plus a list of gaps to fill.
Write a guided walkthrough for a complex pull request
Structure complex multi-file pull requests into a clear, numbered narrative review order for your teammates.
Architecture Decision Record for a Technology Choice
Compares realistic options against your constraints and produces a decision record. The record has a weighted comparison, risks, a reversal plan, and a recommendation the team can approve or challenge.
Create a contributing guide and pull request checklist
Generate a clear, friction-free onboarding guide and pull request checklist for new contributors to your repository.
- Document module behavior from its test suite
- Split a large pull request into reviewable commits
- Generate complete API documentation from route code
- Explain a Confusing Coding Tutorial or Docs Passage in Plain English
- Explain Any Regex Token by Token with Matching and Failing Examples
- Resolve a Git Merge Conflict and Keep What Both Branches Intended