Architecture Documentation for Technical Architects
Use REST API definitions, schemas, diagrams, NFRs, and failure scenarios to create detailed technical architecture documentation.
Technical architects focus on detailed system design, APIs, and infrastructure. Content Foundry provides blocks that connect documentation directly to technical definitions.
Key Blocks for Technical Architects
REST API Definition
Live API documentation embedded in context
Schema Definition
Request and response schemas
Diagram
C4 diagrams, infrastructure, network topology
NFR
Performance, scalability, and security requirements
Failure Scenario
Resilience planning and recovery procedures
REST API Endpoint Block
Embed live API documentation:
Schema Definition Block
Embed schema documentation:
Technical Diagrams
Use the diagram editor for technical views:
C4 Diagrams
Context, container, component, code views
Infrastructure
Network topology, deployment architecture
Sequence Diagrams
Request and response flows
Component Diagrams
Service boundaries and dependencies
Technical NFRs
Document measurable technical requirements:
| Category | Examples |
|---|---|
| Performance | Response time, throughput, resource utilisation |
| Scalability | Concurrent users, requests per second |
| Security | Encryption, authentication, authorisation |
| Availability | Uptime percentage, RTO, RPO |
Failure Scenarios
Document failure modes and recovery:
Example Failure Scenarios
| Scenario | Description |
|---|---|
| Database Unavailable | Primary database connection lost |
| API Gateway Overload | Traffic spike exhausts connections |
| Cache Invalidation | Stale data served after update |
| Network Partition | Region connectivity lost |
| Key Rotation | API key leaked, needs rotation |