write-rich-descriptions

Create structured metadata blocks and Markdown tables for architecture elements.

5|1|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/a-scolan/c4-template --skill write-rich-descriptions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-rich-descriptions
Source: https://github.com/a-scolan/c4-template/tree/main/.github/skills/write-rich-descriptions
Command: npx skills add https://github.com/a-scolan/c4-template --skill write-rich-descriptions

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about write-rich-descriptions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create machine-readable architecture documentation?

You create machine-readable architecture documentation by defining system-model metadata blocks for business context and Markdown tables for deployment details, ensuring elements are queryable while remaining human-friendly.

What is the best way to structure deployment descriptions in architecture docs?

The best way to structure deployment descriptions is using a single Markdown table per element in your deployment model to present network, hardware, and service details in a readable format.

How do metadata blocks work for system models?

Metadata blocks work by capturing business context and technical details for containers and components in a structured format, enabling machine-readable queries across your architecture documentation.

Can I use arrays and cross-references in architecture documentation?

Yes, you can use arrays for multi-valued fields and cross-references to link related resources, avoiding duplication and keeping documentation consistent and navigable across elements.

How do I document a new service with system metadata and deployment tables?

To document a new service, describe it using a metadata block in system-model.c4, then add a deployment description in deployment.c4 with a single Markdown table and links to related resources.

When should I not use Markdown tables in deployment descriptions?

You should avoid using multiple Markdown tables per element in deployment descriptions, as the recommended approach enforces a single deployment table per element to maintain readable and consistent documentation.