Creating flow docs

Document one operation's observable behavior using the project's existing flow-document convention.

Establish the convention

Read the local conventions and one or two existing flows. Match language, filenames, section order, actor names, and diagram format. Use an ordinal only when that convention exists.

Flow docs cover operations, queries, scheduled work, and implementation gaps. Use architecture docs for system-wide structure and runbooks for operational procedures.

Choose the variant

Variant	Purpose	Distinct sections
Write/action	State-changing operation	Preconditions, mutations, optional state diagram
Read/query	Read and return data	Preconditions, result shape, filtering/pagination
System/cron	Scheduled or event-triggered work	Trigger and scheduling conditions
Gap/legacy	Expected behavior differs from implementation	Current behavior, impact, current flow, recommended fix, verification

z-creating-flow-doc

Creating flow docs

Establish the convention

Choose the variant