Logo
NeoArc Studio

Using Content Blocks

Master the specialised content blocks for architecture documentation including decisions, risks, technical specifications, and diagrams. Add blocks via the block panel, fuzzy search, or the command palette.

Content Foundry provides a wide range of specialised block types covering layout, data, decisions, requirements, diagrams and more, designed for enterprise architecture documentation. There are three ways to add blocks to your pages: browsing by category, searching within the Add Block panel, or using the command palette.

Adding Blocks via the Block Panel

The Add Block panel provides category browsing and fuzzy search across all block types.

Adding Blocks via the Command Palette

The command palette provides the fastest way to add a specific block type when you already know what you need.

Text & Media (12 Types)

General content and media elements:

Rich Text
HTML content with headings, lists, links, and formatting
Image
Image display with optional caption and upload
Code
Syntax-highlighted code in 50+ languages
Callout
Info, warning, tip, and danger callouts
Blockquote
Styled quotations with attribution
Link
Internal page links with preview card
YouTube Video
Embedded YouTube videos
Audio
Audio player with metadata and upload
Embed
External content via iframe embeds
File Download
Downloadable files with label and upload
Math/LaTeX
Mathematical formulas and equations
Infographic
Standalone infographic at correct aspect ratio

Layout (11 Types)

Structure and organise page content:

Table of Contents
Auto-generated page navigation
Table
Structured data in rows and columns
Definition List
Term and definition pairs for glossaries
Accordion
Collapsible sections for progressive disclosure
Tabs
Tabbed content for alternative views
Steps
Numbered step-by-step instructions
Card Grid
Visual cards with icons and descriptions
Image Gallery
Multiple images in a responsive grid
Badge List
Coloured badges for tags and labels
Divider
Visual separator between sections
Editor Instruction
Internal notes that are not published

Diagrams (7 Types)

Visual architecture and decision elements:

Diagram
Architecture and flow diagrams from the diagram editor
Presentation
Animated diagram presentations with playback
Graph Diagram
D3 force-directed graph diagrams
Graph Links
Navigation graphs with clickable nodes
Mermaid
Diagrams defined with Mermaid syntax
Trade-off Matrix
Decision matrices for comparing options with scoring
Deployment View
Infrastructure and deployment visualisation

Decisions (7 Types)

Capture the reasoning behind architecture:

ADR Link
Link to an existing architecture decision record
ADR
Inline architecture decision record
Assumption
Project assumptions with confidence and validation
Constraint
Project constraints with type and impact
Principle
Architecture principles with rationale
NFR
Non-functional requirements with measurable targets
Solution Option
Alternative solutions for decision comparison

Risk (6 Types)

Manage uncertainty, threats, and resilience:

Risk
Individual risk with likelihood and impact
Risk Register
Collection of risks in matrix visualisation
Failure Scenario
Failure mode with detection and recovery steps
Scenario / What-If
Scenario analysis with conditions and outcomes
Threat Model
Security threat modelling with STRIDE methodology
Security Control
Security control documentation and mitigation

APIs & Data (15 Types)

Connect documentation to technical artifacts:

REST API
Link to a REST API definition file
REST Endpoint
Embed a specific REST API endpoint
GraphQL API
Link to a GraphQL API definition
GraphQL Operation
Embed a specific GraphQL operation
Schema
Embed schema definitions with field details
Component Responsibility
Component roles, interfaces, and boundaries
Data Lifecycle
Data management stages and retention
Data Flow
Data flow specifications and pipelines
Interface Contract
API contract and specification documentation
Event Specification
Async event and message specifications
Search Model
Search configuration and index documentation
Operational Note
Operations documentation with severity levels
Dependency Matrix
Component and service dependency tracking
Technology Radar
Technology assessment with adopt/assess/hold ratings
API Versioning
API versioning strategy documentation

Requirements (19 Types)

Capture and structure project requirements:

User Story
Agile user stories with acceptance criteria
Use Case
Actor and scenario documentation
PRD
Product Requirements Document
BRD
Business Requirements Document
FRD
Functional Requirements Document
SRS
Software Requirements Specification
Timeline
Schedule visualisation with milestones
RACI Matrix
Role and responsibility assignments
Stakeholder Map
Stakeholder roles and influence mapping
Gap Analysis
Current state vs target state analysis
Quality Attribute
Quality attribute scenarios for NFR validation
Business Process
Business process and workflow documentation

Testing (6 Types)

Document testing strategy and verification:

Test Case
Individual test case with verification steps
Test Suite
Collection of related test cases
Coverage Matrix
Test coverage tracking across requirements
Quality Gate
Quality gate criteria and approval requirements
Traceability Matrix
Requirement-to-test traceability
Fitness Function
Evolutionary architecture fitness function metrics

Operations (8 Types)

Capture operational procedures and configurations:

Operational Note
Critical operational knowledge and procedures
Runbook
Step-by-step operational procedures
Incident Response Plan
Incident response and escalation procedures
RPO/RTO Specification
Recovery point and time objectives
Deployment Checklist
Deployment and release verification
Environment Config
Environment configuration documentation
Feature Flag
Feature flag and toggle documentation
Configuration Item
Configuration parameter documentation

Planning (10 Types)

Plan and track architecture initiatives:

Timeline
Schedule and milestone visualisation
RACI Matrix
Role and responsibility assignments
Stakeholder Map
Stakeholder identification and mapping
Roadmap Item
Roadmap entries with strategic planning
Gap Analysis
Current vs target state analysis
Migration Step
Migration and transition planning
Person/Team Card
Person or team contact and role information
Technical Debt
Technical debt tracking and prioritisation
Change Impact
Change impact assessment documentation
Capacity Plan
Capacity planning and growth projections

Reference (16 Types)

Stable reference documentation and standards:

Service Catalog
Service catalogue entries with ownership
SLA/SLO
Service level agreements and objectives
Integration Spec
Integration specification documentation
Data Dictionary
Data field definitions and glossary
Glossary Term
Glossary term and definition entries
Technology Standard
Approved technology standards
Architecture Pattern
Reusable architecture pattern documentation
Compliance Requirement
Regulatory compliance requirements
Governance Checklist
Governance review checklists
Changelog
Version history with categorised changes
Metric Display
KPI and metric visualisation
Vendor Assessment
Vendor evaluation and assessment

Block Metadata

Each block supports optional metadata:

Block Actions

Manage blocks in your page:

ActionDescription
Move Up/DownReorder blocks
DeleteRemove a block
Edit MetadataAdd title or description
Copy/PasteDuplicate blocks

Best Practices

Use Appropriate Blocks
Structured blocks are better than unstructured text
Add Metadata
Titles help navigation and search
Link Diagrams
Keep documentation in sync with diagrams and schemas
Use Risk Blocks
Make risks visible, not hidden in spreadsheets
Document Decisions
Capture assumptions, constraints, and principles