Logo
NeoArc Studio

How-To Guides

Step-by-step guides for common documentation tasks including creating diagrams, documenting APIs, modelling data, managing architecture decisions, and publishing documentation sites.

These how-to guides provide step-by-step instructions for common documentation tasks in NeoArc Studio. Each guide focuses on a specific goal and walks through the process from start to finish.

Diagrams and Visualisation

Guides covering architecture diagrams, animated presentations, infographics, and architecture transitions.

Data Architecture

Guides for modelling relational and graph database schemas, building data dictionaries, and establishing lineage.

API Documentation

Guides for documenting REST and GraphQL APIs with full schema, security, and example coverage.

Architecture Governance

Guides for capturing decisions, risks, and non-functional requirements.

Collaboration and Publishing

Guides for customising the published site, deploying documentation, and collaborating with teams.