126 lines
4.3 KiB
YAML
126 lines
4.3 KiB
YAML
name: "Structurizr Workspace Template"
|
|
description: "Template for creating complete Structurizr workspaces with all C4 model levels"
|
|
version: "1.0"
|
|
|
|
sections:
|
|
- id: workspace-overview
|
|
title: "Workspace Overview"
|
|
instruction: "Define the workspace metadata and scope"
|
|
fields:
|
|
- id: workspace-name
|
|
title: "Workspace Name"
|
|
type: "text"
|
|
required: true
|
|
placeholder: "e.g., E-commerce Platform Architecture"
|
|
- id: workspace-description
|
|
title: "Workspace Description"
|
|
type: "textarea"
|
|
required: true
|
|
placeholder: "Brief description of the workspace and its purpose"
|
|
- id: target-audience
|
|
title: "Target Audience"
|
|
type: "list"
|
|
required: true
|
|
placeholder: "Who will use these diagrams? (e.g., Developers, Architects, Stakeholders)"
|
|
|
|
- id: system-context
|
|
title: "System Context (Level 1)"
|
|
instruction: "Define the system context diagram elements"
|
|
fields:
|
|
- id: system-name
|
|
title: "System Name"
|
|
type: "text"
|
|
required: true
|
|
placeholder: "Name of the main system"
|
|
- id: system-description
|
|
title: "System Description"
|
|
type: "textarea"
|
|
required: true
|
|
placeholder: "What does the system do?"
|
|
- id: users
|
|
title: "Users"
|
|
type: "list"
|
|
required: true
|
|
placeholder: "List of users (e.g., Customers, Administrators, Support Staff)"
|
|
- id: external-systems
|
|
title: "External Systems"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List external systems (e.g., Payment Gateway, Email Service)"
|
|
|
|
- id: containers
|
|
title: "Containers (Level 2)"
|
|
instruction: "Define the container diagram elements"
|
|
fields:
|
|
- id: web-apps
|
|
title: "Web Applications"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List web applications"
|
|
- id: mobile-apps
|
|
title: "Mobile Applications"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List mobile applications"
|
|
- id: apis
|
|
title: "APIs and Services"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List APIs and microservices"
|
|
- id: databases
|
|
title: "Databases"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List databases and storage systems"
|
|
|
|
- id: components
|
|
title: "Components (Level 3)"
|
|
instruction: "Define component diagrams for key containers"
|
|
fields:
|
|
- id: key-containers
|
|
title: "Key Containers for Component Diagrams"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List containers that need component diagrams"
|
|
- id: component-types
|
|
title: "Component Types"
|
|
type: "list"
|
|
required: false
|
|
placeholder: "List component types (e.g., Controllers, Services, Repositories)"
|
|
|
|
- id: styling
|
|
title: "Styling and Theming"
|
|
instruction: "Configure visual appearance"
|
|
fields:
|
|
- id: color-scheme
|
|
title: "Color Scheme"
|
|
type: "text"
|
|
required: false
|
|
placeholder: "Preferred color scheme (e.g., default, corporate, custom)"
|
|
- id: layout-preferences
|
|
title: "Layout Preferences"
|
|
type: "textarea"
|
|
required: false
|
|
placeholder: "Any specific layout preferences or constraints"
|
|
|
|
- id: llm-instructions
|
|
title: "LLM Instructions"
|
|
instruction: "AI processing instructions for generating the DSL"
|
|
content: |
|
|
Based on the provided information, generate a complete Structurizr DSL workspace that includes all C4 model levels. Follow these guidelines:
|
|
|
|
1. Create a workspace with the specified name and description
|
|
2. Define the model section with all elements from all levels
|
|
3. Create appropriate views for each C4 model level:
|
|
- System context view for Level 1
|
|
- Container views for Level 2
|
|
- Component views for Level 3
|
|
4. Use consistent naming and descriptions throughout
|
|
5. Apply appropriate technology labels for relationships
|
|
6. Include autolayout for all views
|
|
7. Apply the default theme or specified styling
|
|
8. Ensure all relationships are properly defined
|
|
9. Make the DSL complete and ready to use with Structurizr Lite
|
|
|
|
The DSL should be comprehensive and include all necessary elements for a complete C4 model representation.
|