Technical Blocks
Reference for the 7 technical category blocks: Component Responsibility, Data Lifecycle, REST API Endpoint, API Schema, Search Model, Operational Note, and Mermaid Diagram.
The Technical category includes 7 blocks for documenting components, data management, and embedding live API and schema definitions. These blocks connect documentation to actual technical artifacts.
Component Responsibility Block
Documents component roles, responsibilities, and interfaces.
| Property | Type | Description |
|---|---|---|
| componentName | string | Component name (required) |
| description | string | Component description |
| responsibilities | array | What this component does (required) |
| outOfScope | array | What this component does NOT do |
| inputs | array | What this component receives |
| outputs | array | What this component produces |
| ownedData | array | Data this component is authoritative for |
| dependencies | array | Other components this depends on |
| status | enum | Status: proposed, active, deprecated |
Data Lifecycle Block
Documents data management across its lifecycle stages.
| Property | Type | Description |
|---|---|---|
| dataName | string | Data entity name (required) |
| description | string | Data description |
| creation | string | How data is created (required) |
| ingestion | string | How data enters the system |
| transformation | array | Transformations applied |
| storage | array | Where data is stored (required) |
| access | array | Who/what can access |
| sharing | array | How data is shared externally |
| retentionPolicy | string | How long data is kept |
| archival | string | Archival process |
| deletion | string | Deletion process |
| dataOwner | string | Data owner |
| dataClassification | enum | Classification: public, internal, confidential, restricted |
REST API Endpoint Block
Embeds REST endpoint documentation from API definitions.
| Property | Type | Description |
|---|---|---|
| restApiDefinitionId | string | Reference to REST API definition |
| endpointId | string | Specific endpoint ID to embed |
API Schema Block
Embeds schema documentation from schema definitions.
| Property | Type | Description |
|---|---|---|
| schemaId | string | Reference to schema definition |
Operational Note Block
Documents operational information with severity levels.
| Property | Type | Description |
|---|---|---|
| title | string | Note title (required) |
| description | string | Note content (required) |
| environment | enum | Environment: production, staging, development, all |
| appliesTo | string | What service/component |
| symptoms | array | Observable symptoms |
| recommendedAction | string | What to do |
| workarounds | string | Temporary fixes |
| impact | string | Impact if not addressed |
| riskLevel | enum | Risk: low, medium, high |
| status | enum | Status: active, informational, obsolete |
Mermaid Diagram Block
Renders Mermaid.js diagrams from text-based syntax.
| Property | Type | Description |
|---|---|---|
| code | string | Mermaid diagram code |