Appearance
Glossary
This glossary explains how the shared documentation uses common terms. It does not define repository-specific field names or API contracts.
| Term | Meaning in this documentation |
|---|---|
| Business owner | The system responsible for the behavior or data meaning. Another system may store a copy or display it without becoming its owner. |
| Producer | A system or job that creates an event, request, file, or data update consumed elsewhere. The exact producer is source-verified only when a flow cites the code path. |
| Consumer | A system or job that receives and processes a request, event, file, or update. A documented relationship alone does not prove which code path consumes it. |
| Contract | The fields, authentication, statuses, ordering, retry rules, and other expectations shared across a boundary. A page should link the owning source when it states a concrete contract. |
| API | A request/response interface. The word does not by itself establish method, route, payload, permissions, or caller. |
| Queue | Work recorded for later processing. Queue names, delivery guarantees, deduplication, and retry behavior must come from source or owner-approved operational documentation. |
| Cron / scheduled command | A command invoked on a schedule. A command implementation does not prove its installed frequency or that it runs in a particular environment. |
| File workflow | A handoff that reads or writes a file, such as an import or export. File name, schema, arrival location, and replay behavior require evidence. |
| Source-verified | The cited repository and immutable commit were checked for the specific statement. This does not prove deployed configuration, production state, or end-to-end acceptance. |
| Documented | A statement is carried by the current documentation or an identified owner description, but the code path has not been verified in the cited source. |
| Partial | Some segments have evidence while other branches, callers, contracts, or operational behavior remain unknown. The page must say which segment is missing. |
| Unknown | The available documentation and source evidence do not establish the fact. It must not be filled with a plausible guess. |
| Legacy | Retained documentation for a former or uncertain path. Check the current owner before using it to make a change. |
| Runbook | Project-owned operational instructions for investigating or responding to a failure. Shared flow pages help locate a boundary; they do not replace a runbook. |
| Repository map | A list of canonical repository identities and confirmed documentation-submodule locations. It is not a deployment inventory. |
See Documentation Coverage for per-system evidence status and next gaps.