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.
| Guide | Description |
|---|---|
| Create an Architecture Diagram | Build an architecture diagram with shapes, connections, icons from Azure, AWS, Kubernetes, CNCF, Lucide and brand collections, and styling |
| Create an Animated Presentation | Build step-based animated presentations with visibility actions, viewport animation, and speaker notes |
| Create an Infographic | Design fixed-size infographics with canvas presets (16:9, 4:3, 1:1, A4 portrait, A4 landscape) and export to SVG, PNG, JPEG, or PDF |
| Document Architecture Transitions | Model current state, interim phases, and target state using version snapshots and transitions with lineage anchoring |
Data Architecture
Guides for modelling relational and graph database schemas, building data dictionaries, and establishing lineage.
| Guide | Description |
|---|---|
| Create an ERD Diagram | Build entity-relationship diagrams with ERD table shapes, crow's foot notation, FK auto-fill, linting, CSV export, and SQL Server import |
| Model a Graph Database | Design graph database schemas in graph-db authoring mode with typed properties, key roles, composite constraints, comprehensive validation, and Cypher DDL export |
| Set Up Schema Lineage | Connect schema fields to database columns for end-to-end data traceability |
| Create a Data Dictionary | Build complete data documentation with schemas, ERDs, lineage, and governance |
API Documentation
Guides for documenting REST and GraphQL APIs with full schema, security, and example coverage.
| Guide | Description |
|---|---|
| Document REST API Endpoints | Create complete REST API documentation with endpoints, parameters, security schemes, and OpenAPI 3.1 export |
| Document a GraphQL API | Document GraphQL APIs with servers, auth schemes, custom scalars, operations (queries, mutations, subscriptions), and example queries |
| Document Microservices | Create service catalogues, responsibility documentation, and API specifications |
Architecture Governance
Guides for capturing decisions, risks, and non-functional requirements.
| Guide | Description |
|---|---|
| Create an Architecture Decision Record | Create ADRs using industry formats (Nygard, MADR, Structurizr, Y-Statement) with full lifecycle tracking, linked diagrams, and Markdown export |
| Document Risks and NFRs | Capture risks, non-functional requirements, constraints, and assumptions with structured blocks |
Collaboration and Publishing
Guides for customising the published site, deploying documentation, and collaborating with teams.
| Guide | Description |
|---|---|
| Customise a Published Site | Configure branding, navigation, theme colour variables, marketing home sections, custom icons, footer, and SEO meta tags |
| Publish a Documentation Site | Deploy documentation locally or to Azure Blob Storage with Cloudflare cache integration |
| Collaborate with Git | Use Git workflows for documentation collaboration including branching and pull requests |
Get up and running with NeoArc Studio in five minutes. Download the app, create a workspace, define your data model, create views, and build your first architecture documentation.
Task-oriented tutorials for creating diagrams, documenting architecture, and publishing your content. Start here to learn how to use NeoArc Studio effectively.
Complete reference for all content block types in Content Foundry. Blocks organised into categories covering documentation, diagrams, charts, decisions, risk, APIs, testing, operations, and marketing.