AI Documentation

Archflow's AI documentation system generates comprehensive architecture documentation by analyzing your systems, connections, workflows, and deployments.

Overview

Instead of writing architecture documentation from scratch, Archflow's AI examines your entire project and generates professional documentation. The AI understands:

• System relationships and hierarchies
• Data flows and integration patterns
• Business processes from workflows
• Infrastructure from deployment views
• Business context from Arc42 profiles

Generation Workflow

Documentation generation follows a three-step modal process:

1. Content Type

Choose what kind of documentation to generate:

• Full Overview --- Complete architecture documentation covering all aspects
• Section --- Generate content for a specific documentation section only

2. Customize Parameters

Fine-tune the generation with these parameters:

Focus areas include:

• Performance & Scalability
• Integration Patterns
• Security & Compliance
• Data Architecture
• DevOps & Deployment
• And more

3. Generate

Review your settings and click Generate. The AI analyzes your architecture and produces structured documentation with:

• Executive summary
• System descriptions and relationships
• Integration patterns and data flows
• Deployment and infrastructure overview
• Business process documentation

Section-Level Editing

Generated documentation supports per-section editing:

• Click any section to open the markdown editor with a professional editing toolbar
• Modify AI-generated content to add project-specific details
• Regenerate individual sections without affecting others
• Mix AI-generated and hand-written content

Selecting Supporting Content

Before generating, choose which workflows and deployments to include:

• Workflows tab --- On the diagram view, open the Workflows tab to select relevant business processes. Use checkboxes to include or exclude individual workflows.
• Infrastructure tab --- Open the Infrastructure tab to choose deployment views. AI recommends deployments based on coverage (≥80%), production priority, and system richness.
• Selections persist --- Both workflow and deployment selections are saved per diagram view with automatic debounced saving.

Image Gallery

Upload and manage images for your documentation:

• Click the image gallery button in the documentation toolbar
• Upload images (PNG, JPEG, WebP, GIF up to 5MB) with automatic optimization
• Images are resized to max 2000px and converted to optimized PNG
• Add descriptions and tags for searchability
• Copy markdown embed syntax (![alt](url)) to paste into documentation sections
• Search and filter images by tags

Custom Pages

Create custom documentation pages with a block-based editor for additional content beyond the main AI-generated documentation. Custom pages support markdown, code blocks, callouts, embedded diagrams, and drag-and-drop content insertion.

See Custom Documentation Pages for the complete guide.

Documentation Templates

Archflow provides reusable documentation templates:

• Browse available templates from the documentation interface
• Templates provide pre-structured content for common documentation needs
• Apply a template to quickly scaffold documentation for new views

Publish Section Selector

Before publishing, choose exactly which sections to include:

• Toggle visibility of individual documentation sections
• Select which custom pages to include
• Choose whether to include blast radius analysis
• Reorder sections for the published view

Publishing

Share your documentation with stakeholders:

• Publish --- Click the publish button to create a shareable version
• Guest Access --- Generate shareable links with access tokens
• Version Control --- Track documentation versions alongside architecture changes
• Custom Themes --- Published documentation respects your project's custom theme
• Responsive Design --- Documentation renders well on all devices
• Tab Navigation --- Published docs include tabs for documentation, systems, connections, workflows, deployments, and blast radius

See Sharing Documentation for the full publishing workflow.

Best Practices

• Add descriptions to systems and connections --- The more context you provide, the better the AI output
• Define workflows first --- Business process context significantly improves documentation quality
• Start with a high-level overview --- Then generate detailed sections for specific areas
• Review and refine --- AI generation is a starting point; always review for accuracy
• Include deployment views --- Infrastructure context adds valuable depth to documentation