README Improvement Loop
This loop helps improve onboarding documentation by iteratively testing and refining README files to ensure new users can successfully set up and run your pr…
This loop is republished with attribution. Full credit and the original content belong to the source linked above.
AI Skill Market Insights
Real data. Real impact.
Emerging
Developers
Kickoff Prompt
Copy this prompt and run it with your agent to start the loop.
Start the "README Improvement Loop" loop.
Goal: Improve onboarding documentation
Max iterations: 10
Between iterations run: fresh setup test
Exit when: Setup works from README
I want to improve my project's onboarding documentation. My goal is to ensure someone can successfully set up and run this project by following only the README instructions. Please run the README Improvement Loop to help me achieve this. Start by analyzing my current README for potential issues, then run a fresh setup test to see if it works as documented. Continue iterating until we meet the exit condition where the setup works from the README, or until we reach 10 iterations.
Self-pace this loop. After each iteration, run `fresh setup test` and evaluate the output, and only continue if the exit condition is not met (Setup works from README). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.