# Refresh onboarding documentation against what the setup scripts do

Onboarding instructions checked by following them on a clean machine rather than by reading them.

Category: Documentation and knowledge
Source: https://letsship.ai/use-cases/refresh-onboarding-documentation
Published: 2026-08-25

## Goal

Update onboarding documentation so every step matches what actually works.

## Acceptance criteria

- Every step is executed on a clean environment
- Steps that are no longer needed are removed
- Undocumented steps people know by habit are added
- The time it takes to complete is recorded

## What lands as proof

A clean-environment walkthrough, which is the only way to find the step everybody does from memory.

## Prompt

Copy this to an agent to open the ticket:

```text
Create a Linear issue in my team and assign it to the SHIP agent.

Title: Refresh the onboarding documentation

Description: Update onboarding documentation so every step matches what actually works.

Acceptance criteria:
- Every step is executed on a clean environment
- Steps that are no longer needed are removed
- Undocumented steps people know by habit are added
- The time it takes to complete is recorded

Before you create the issue, follow this repository's onboarding documentation on a clean environment and record every deviation.
```

## Questions

### What does the agent actually change?

The ticket is scoped to one outcome: update onboarding documentation so every step matches what actually works. Work that serves that outcome is in scope, and anything outside it is left for a separate ticket, so the pull request stays reviewable.

### How do I know the work is done?

The pull request carries the evidence, not only the diff. Here that means each step verified by running it, so a reviewer can confirm the result without reproducing the work locally.

### How much oversight does this need?

None is required before the run starts. Every claim this ticket makes can be checked by machine, so the agent works straight through and a person reviews the finished pull request like any other.