Logo
NeoArc Studio

Data Architecture Documentation

Document data architecture with a model-first workflow: define entities in the central data model, create data views with database profiles, build schemas with model-property lineage, document 6 API types (REST, GraphQL, AsyncAPI, Webhooks, MCP, gRPC), and generate 16 governance reports with PDF export.

Model-First Data Documentation

Data architecture documentation breaks down when entities are defined in one place, diagrammed in another, and described in a third. Changes to one artefact leave the others stale. A model-first workflow solves this: entities are defined once in a central data model (model.neoarc), then surfaced through data views that provide unified interactive exploration covering relational structure with database profiles, conceptual relationships with force-directed layouts, and search index configuration. Schema definitions link back to model properties for lineage, and project reports aggregate coverage metrics for governance.

The Model-First Workflow

Documentation Capabilities

Data Views in Detail

Data views are the primary visualisation for data architecture. They unify what were previously separate ERD, graph, and search views into a single interactive exploration surface. Each view derives its content from the data model.

Schema Lineage to Model Properties

Schema fields link to their source properties in the data model, creating a traceable path from database column to API field.

Schema Validation

Graph Visualisations within Data Views

Data views include D3 force-directed layouts to show entity relationships at a conceptual level. Each node represents an entity from the model with configurable property display. The graph visualisation complements the relational table view: use the graph layout for high-level overviews and the table layout for detailed physical schemas.

Project Reports for Governance

Project reports provide coverage metrics across the data model, schemas, and documentation pages.