Write a developer environment setup guide and test it

A developer setup guide with pinned versions, ordered steps and common failures.

Choose one of three approaches. The steps for that option appear below.

Choose an option above. On a phone, swipe the tabs left or right to see all options →

Cursor: drafts the setup guide and newcomer test sheet

Cursor drafts steps, guide and test sheet; you check versions and sources before a newcomer tests on a clean machine.

  1. You

    Collect the repository and onboarding

  2. Cursor

    Draft steps, guide

  3. The new developer

    Test the approved guide and

  1. Collect the repository and onboarding notes

    Use: You

    Have ready: current repository, README fragments, Makefile, scripts and complete onboarding thread notes in the Cursor workspace.

    Check

    Proprietary code goes into an external tool only if your organisation's rules allow it.

  2. Draft steps, guide and the test sheet

    Use: Cursor

    Ask Cursor for steps and versions, then guide and test sheet; check pinned versions and approve ordering before each dependent draft.

    Details

    What to paste into the tool

    Task: Draft step list (Numbered list with versions). Read the Makefile, README fragments and these onboarding notes. Draft a numbered setup step list for a new developer, naming each tool and the version exactly as pinned or stated. Mark any step where the sources disagree. Task: Draft guide (Markdown guide with numbered steps). Write a Markdown setup guide from this checked step list: numbered steps, versions as given, and a troubleshooting section drawn only from the repo files and onboarding notes. Task: Draft newcomer test sheet. Turn each numbered step of this guide into a test sheet row: step number, what to do, expected result, and a blank field for what actually happened.

  3. Follow the guide and record every failure

    Use: The new developer

    Follow the approved guide exactly on a clean machine; record every failure's step number for the team lead to collect and fix.

    Check

    Versions must come from the repo or notes. Remove unsupported steps and troubleshooting. Check the test sheet covers every guide step in order.

Before you paste into any AI tool, remove any confidential information. Put it back at the end.

Tools in this workflow

Deciding between Cursor and Replit (Replit Agent) for this? See the comparison.

Final check

Versions appear only as supplied by the repo or notes.

The team lead approves the guide's ordering and troubleshooting section.

The test sheet covers every guide step in order.

A newcomer follows the guide on a clean machine and lists the step where each problem occurred.

Check data-handling rules before placing proprietary repo material into any tool.

Check the result against your original inputs. Approve it before sharing or acting.

What still needs checking
  • Whether proprietary repo material may be placed into any of these tools is for the organisation to confirm.

Share this page