Organize a project README overview in Claude Code

Lead with an overview, quick navigation, and a project flow diagram grounded in real code and documentation.

Install in Claude Code

A Claude Code workspace with source and specialist documentation. Follow the ambrouse repository's README structure. Its own README uses Vietnamese with diacritics.

Review `.claude/skills/readme-style/SKILL.md` and its requirements at the pinned GitHub commit.
Create `.claude/skills/readme-style/` in your project and save the reviewed file as `.claude/skills/readme-style/SKILL.md`.
Start Claude Code from that project's root, then select `/readme-style` in the slash menu.

Example task

The fictional site connects `[Schedule, Print adapter, Preview]`. Previewing rehearsal forms is implemented, while email notices are still planned. Reflect both states in the README.

What to check

After the overview, add a Mermaid flow with nodes corresponding to `Schedule --> Adapter[Print adapter] --> Preview`. Link existing usage docs from quick navigation and mark email notices as planned in the accuracy notes.

Original SKILL.md on GitHub · Updated 2026-11-14

Frequently asked question

How should a README flow diagram explain implemented behavior?

Verify module boundaries and call order in source, then show the implemented steps. Keep details in specialist docs and label planned features.