Skip to content

Glossary ​

This glossary explains how the shared documentation uses common terms. It does not define repository-specific field names or API contracts.

TermMeaning in this documentation
Business ownerThe system responsible for the behavior or data meaning. Another system may store a copy or display it without becoming its owner.
ProducerA 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.
ConsumerA 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.
ContractThe 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.
APIA request/response interface. The word does not by itself establish method, route, payload, permissions, or caller.
QueueWork recorded for later processing. Queue names, delivery guarantees, deduplication, and retry behavior must come from source or owner-approved operational documentation.
Cron / scheduled commandA command invoked on a schedule. A command implementation does not prove its installed frequency or that it runs in a particular environment.
File workflowA handoff that reads or writes a file, such as an import or export. File name, schema, arrival location, and replay behavior require evidence.
Source-verifiedThe cited repository and immutable commit were checked for the specific statement. This does not prove deployed configuration, production state, or end-to-end acceptance.
DocumentedA statement is carried by the current documentation or an identified owner description, but the code path has not been verified in the cited source.
PartialSome segments have evidence while other branches, callers, contracts, or operational behavior remain unknown. The page must say which segment is missing.
UnknownThe available documentation and source evidence do not establish the fact. It must not be filled with a plausible guess.
LegacyRetained documentation for a former or uncertain path. Check the current owner before using it to make a change.
RunbookProject-owned operational instructions for investigating or responding to a failure. Shared flow pages help locate a boundary; they do not replace a runbook.
Repository mapA 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.

Internal developer documentation for Menzzo systems.