Software projects
Check a README for missing setup information
Read the README as someone who has never seen the project and wants a working example. Record each prerequisite, setup step and expected output, then note where a newcomer would get stuck, such as an unexplained command, a missing tool or a step that needs a credential.
A text to start with
Here is the README for [project]: [paste text]. Assume the reader knows [assumed skill level] and nothing about this project. Walk through it as a new contributor and list the prerequisites, each setup step, the output they should see, and common failures. Flag commands that need secrets or accounts, steps that are never explained, and any place the docs assume prior knowledge.
Example request. Change the details to fit your situation.README onboarding checklist
Project and README version reviewed: [ ] Assumed reader background: [ ] Prerequisite and version: [ ] Where the README says to get it: [ ] Setup step: [ ] Command as written: [ ] Expected output stated: [yes / no] Common failure and fix: [ ] Command needing a secret or account: [ ] Safe alternative offered: [ ] Step or term never explained: [ ] First working example reached at step: [ ] Help route listed (issues, chat, email): [ ] Gap fixed or question for maintainers: [ ]
Gaps a newcomer hits first
Check versions: a tool listed without one, or a version that conflicts with another instruction. Confirm every command can run in the order written, and that earlier steps create anything later steps depend on. Mark commands that need an API key, token or private account, and see whether the README says where a contributor gets one or offers a safe alternative such as sample values. Expected output should be shown so the reader can tell success from failure. Note jargon and abbreviations the README never defines, and any link you cannot verify.
Ask another agent to check the result
Read this README as a first-time contributor. Flag every command that requires a secret, token or account the docs never explain how to obtain, and every step that depends on knowledge the README does not provide. Say where in the sequence a newcomer would first be blocked.
Fix and retest
Prioritize gaps by where they block the reader: anything before the first working output comes first. Draft the missing sentences or commands, then run the revised steps on a clean machine or ask a new contributor to try them. Add a short section saying where to ask for help. Keep a note of the issues you fix so maintainers can see what changed.