Prompting Guide

Use these instructions when asking an AI coding agent to create or update DiagramPilot diagrams.

Recommended Agent Instruction

Create or update a DiagramPilot diagram in this repository.
Use a structured .dp.yaml source file, run the read-only repo check and inspect
inventory first, preserve stable IDs, validate the spec, and render an SVG
artifact with an explicit --out path. Render PNG with `--format png` only when
a raster artifact is needed. Do not hand-edit generated artifacts.

Architecture Prompt

Create docs/architecture.dp.yaml showing the main runtime components in this
project. Use stable lowercase snake case IDs, group related services, include
labeled edges for major data flows, validate the spec, and render
docs/architecture.svg.

Update Prompt

Update the existing DiagramPilot source file to include the new payment service.
Preserve all existing IDs unless an ID is invalid. Add only the new nodes and
edges required, validate, and render the SVG again.

Review Prompt

Run diagrampilot check for this repository. Review .dp.yaml files for broken
references, duplicate IDs, invalid group containment, unknown icons, unclear
labels, and stale expected SVG artifacts. Report findings and fix only the
issues directly related to DiagramPilot diagrams.

Inventory Prompt

Run diagrampilot inspect --json for this repository and summarize the
DiagramPilot Source Files, Stable IDs, topology, and missing or stale artifact
expectations. Do not edit or generate files.

Export Prompt

Export docs/architecture.dp.yaml to DOT and show me the output. Do not write an
exported file unless I ask for one.

Use --out when the exported Mermaid, D2, or DOT artifact should be written to disk.

Bad Prompt Pattern

Make me a nice architecture diagram.

This is too vague. It does not specify where the source should live, whether to validate, or how to preserve durable editability.

Good Prompt Pattern

Create a DiagramPilot source file at docs/architecture.dp.yaml for the auth,
API, worker, queue, and database components. Render docs/architecture.svg.
Use stable IDs and include labels on edges that describe protocols or data flow.