write-rich-descriptions

What problem does it solve?

Create rich, structured descriptions for architecture elements.

Core Features & Use Cases

• System-model metadata blocks: Use metadata { } blocks to capture business context and technical details for containers and components, enabling queryable data.
• Deployment-model tables: Use Markdown tables in deployment descriptions to present network, hardware, and service details in a readable format.
• Cross-linking & best practices: Avoid duplication and reuse references across elements to keep docs consistent and navigable.
• Use Case: Document a new Upload Service by describing its system metadata and deployment table for a complete, machine-readable and human-friendly description.

Quick Start

• Create a new element and describe it using a metadata block in system-model.c4, then add a deployment description in deployment.c4 with a single Markdown table.
• Include links to related resources.
• Validate that arrays are used for multi-valued fields and that references are properly linked.