Use cases / 🗂️ Work & office

Write docs for your project

Your agent reads your code and writes a README and guides a newcomer can follow.

How your agent does it

  1. Reads the project
  2. Writes a clear README
  3. Adds setup steps that work
  4. Explains the main parts

Example prompt

Read this project and write a README with setup steps and an overview of how it works.

Good to know

  • Difficulty: easy
  • Typical benefit: Hours
  • Works best on: Claude Code, Codex
  • Agent job: Docs Writer, with Teacher

More in Work & office