Workflow Documentation

Write a README

Workflow for creating an effective project README

documentationreadmeonboarding
CLAUDE.md

When writing a project README:

  1. Start with a one-line description of what the project does and who it’s for.
  2. Add a quick start section: prerequisites, install steps, and how to run the project. Test these steps on a clean checkout.
  3. Add a brief overview of the project structure if it’s not obvious.
  4. Add usage examples showing the most common operations.
  5. Add a development section: how to run tests, lint, and build.
  6. Add environment setup instructions: required env vars, external services, database setup.
  7. Keep it concise. Link to detailed docs rather than putting everything in the README.

Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.

get crystl