Logo
NeoArc Studio

Architecture Documentation (Content Foundry)

Content Foundry provides a wide range of specialised content blocks covering layout, data, decisions, requirements, diagrams and more for architecture documentation, technical specifications, and knowledge bases. Capture decisions, risks, requirements, operations, and planning in structured, searchable formats with page versioning and comprehensive theme colour variables.

Block Categories at a Glance

Every block type serves a specific documentation purpose. The categories cover the full lifecycle of architecture work.

CategoryBlocksPurpose
Decision4Assumptions, constraints, principles, NFRs
Risk4Individual risks, risk registers, failure scenarios, what-if analysis
Technical6Component responsibilities, data lifecycle, trade-off matrices, operational notes
Requirements19Functional requirements, acceptance criteria, user stories, use cases, business rules
Testing6Test plans, test cases, test matrices, coverage tracking
Operations8Runbooks, deployment checklists, monitoring definitions, incident templates
Planning10Roadmaps, milestones, dependency tracking, capacity planning
Reference16Glossaries, lookup tables, configuration references, environment matrices
Content6+Rich text, code blocks, images, videos, tables of contents, links
Diagram4Standard diagrams, presentation diagrams, graph diagrams, graph links
Integration2+Embedded REST API endpoints, embedded schema definitions
Marketing4Hero banners, animated hero backgrounds, feature grids, call-to-action buttons

Decision Documentation

Architecture is about decisions. Content Foundry gives you structured blocks to capture the thinking behind your designs.

Assumptions
Document what you are betting on. Every architecture rests on assumptions about load, user behaviour, third-party services, and organisational constraints.
Constraints
Capture the boundaries you are working within. Budget limits, technology mandates, compliance requirements, existing system dependencies.
Principles
Establish design rules that guide decisions. Principles like "prefer managed services" or "zero trust networking" create consistency across teams.
Non-Functional Requirements
Define quality requirements with measurable targets. Response time under 100ms at P95. Availability of 99.9%. Recovery time objective of 4 hours.

Risk Documentation

Architecture decisions involve trade-offs and risks. Content Foundry helps you document them systematically.

Individual Risks
Document specific risks with impact assessments and mitigation strategies. Link risks to the components they affect so the connection is always clear.
Risk Registers
Create complete risk views with prioritisation. See all project risks in one place with owners, statuses, and mitigation progress.
Failure Scenarios
Document what happens when things break. Detection methods, impact scope, recovery steps. On-call engineers find this information when they need it most.
What-If Analysis
Explore potential changes before they happen. What if traffic grows 10x? What if you need to support a new region? Show you have considered the future.

Requirements, Testing, and Planning

Content Foundry extends beyond architecture decisions into the full documentation lifecycle.

Technical Documentation

Connect your documentation to live definitions and capture operational knowledge.

Component Responsibilities
Define clear ownership boundaries. What does each service own? What does it explicitly not own? Clear responsibilities prevent confusion and duplicated effort.
Data Lifecycle
Document data from creation to deletion. Collection, processing, storage, archival, and disposal. Required for GDPR, CCPA, and other data protection compliance.
Embedded API Endpoints
Reference your REST API definitions directly in documentation. When the API definition changes, the embedded documentation updates automatically.
Embedded Schemas
Include schema definitions inline in your documentation. Data structures stay synchronised with their authoritative definitions.
Trade-off Matrices
Show your working. Compare options with weighted criteria and scores. Demonstrate that you considered alternatives and made a reasoned choice.
Operational Notes
Capture critical operational knowledge. Deployment considerations, monitoring requirements, known issues. Information that on-call engineers need at 3am.

Adding Blocks

Content Foundry provides three ways to add blocks to a page, from browsing to keyboard-driven workflows.

Block Panel with Categories
Click Add Block to open the panel and browse 13 categories. Each category groups related block types so you can discover available options.
Fuzzy Search
Type in the search bar within the Add Block panel to fuzzy-search across all block types by name, description, or category. Navigate results with arrow keys and press Enter to select.
Command Palette
Press Ctrl+Shift+P and type the block name to add it directly. Block commands appear automatically when a Content Foundry page is the active editor.

Page Versioning

Content Foundry tracks page history with version stamping.

Stamp Versions
Create named version snapshots of any page at any time. Each stamp captures the complete page state for future reference.
Restore Versions
Restore a page to any previously stamped version. Roll back changes when a revision introduces errors or when you need to return to a known-good state.
Delete Versions
Remove outdated version stamps to keep the history clean. Deleted versions do not affect the current page content.

Site Customisation and Forms

Content Foundry includes site-level customisation and interactive form support.

FeatureDetails
Theme Colour VariablesCSS colour variables for complete site customisation, covering backgrounds, text, borders, accents, and component-specific colours
Forms9 control types for interactive content: text input, textarea, select, checkbox, radio, date picker, number, toggle, and file upload
Marketing Home Sections6 section types for landing pages: hero, feature-grid, CTA, graph-links, diagram, and graph-diagram

Content and Diagrams

Content Foundry includes standard documentation blocks plus diagram integration.

Rich Text
Narrative content with full formatting support.
Code Blocks
Syntax highlighting for 50+ languages.
Images and Videos
Visual content for diagrams and demonstrations.
Tables of Contents
Auto-generated navigation for long documents.
Embedded Diagrams
Include diagrams from the main diagram editor.
Graph Diagrams
Relationship visualisation with force-directed layouts.

Documentation That Stays Current

When documentation lives alongside code in the same repository, the same pull request can update both an API implementation and the architecture pages that describe it. Reviewers see the full picture. Merge conflicts surface when two people change the same documentation, just as they would for code. There is no separate documentation system to remember to update later.

This documentation site was built entirely using Content Foundry. Every page you read here uses the same blocks and publishing workflow available to you.