Use when a code repository needs a README a newcomer can rely on to understand, install, and run the project, and you want it to stay accurate to the actual code; works for any language and handles monorepos.
OutcomeA newcomer can understand, install, and run the project from its README on the first attempt, and the README's commands and links stay accurate to the code.
Use when you can describe a flow, architecture, data model, state machine, class layout, or topic tree in one or two sentences and want a clean, shareable diagram back without learning Mermaid syntax or opening a separate diagramming tool. You get a diagram source you can paste anywhere plus a rendered image you can drop into docs, slides, or chat.
OutcomeA shareable diagram of what you described, ready to drop into documentation, a slide, or a chat thread.