Skip to content
ArchTect Docs

Documentation Map

ArchTect can generate structured architecture documentation from your model, following the arc42 template.

What is arc42?

Section titled “What is arc42?”

arc42 is a widely-used template for software architecture documentation. It organizes documentation into standardized sections that cover different aspects of the architecture — from business context to deployment.

Generating documentation

Section titled “Generating documentation”

VS Code extension

Section titled “VS Code extension”
  1. Open your project in the ArchTect editor.
  2. Command Palette → ArchTect: Generate Documentation.
  3. The generated Markdown files are saved to the output folder.

Browser app

Section titled “Browser app”
  1. Open the Architecture menu in the top bar.
  2. Select Generate Documentation.
  3. Download the generated Markdown files.

View-to-section mapping

Section titled “View-to-section mapping”

ArchTect automatically maps your views to the correct arc42 sections:

arc42 section C4 / Structurizr view type
Context & Scope System Landscape, System Context
Building Block View Container, Component
Runtime View Dynamic
Deployment View Deployment

AI-assisted documentation

Section titled “AI-assisted documentation”

ArchTect can use AI to enhance generated documentation:

  • Section descriptions — AI generates prose descriptions for each arc42 section based on the elements and relationships in your model.
  • Element summaries — AI describes the purpose and role of elements based on their names, descriptions, and relationships.
  • Gap detection — AI identifies sections that lack views or content.

Output format

Section titled “Output format”

Generated documentation is saved as Markdown files, one per arc42 section. The output includes:

  • Embedded diagram references (PNG or SVG exports)
  • Element tables with names, descriptions, and technologies
  • Relationship tables
  • View descriptions and titles

See also

Section titled “See also”