# Write the README for a package that has none

A package with no entry documentation, given one whose setup steps have actually been run.

Category: Documentation and knowledge
Source: https://letsship.ai/use-cases/write-a-missing-readme
Published: 2026-08-25

## Goal

Write a README for a package that has none.

## Acceptance criteria

- It states what the package is for and who consumes it
- Every command in it has been run from a fresh checkout
- It links to the package's tests as executable examples
- It says how to run the package's tests

## What lands as proof

Every command executed from a clean checkout, so the instructions are verified rather than plausible.

## 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: Write the README for {package}

Description: Write a README for a package that has none.

Acceptance criteria:
- It states what the package is for and who consumes it
- Every command in it has been run from a fresh checkout
- It links to the package's tests as executable examples
- It says how to run the package's tests

Before you create the issue, list this repository's packages with no README and replace {package} with the most depended-upon one.
```

## Questions

### What does the agent actually change?

The ticket is scoped to one outcome: write a README for a package that has none. 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 every setup step runs clean from a fresh checkout, 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.