AIS Documentation

Developer documentation for the Asset Information System (AIS): backend, web, mobile, shared contracts, workflows, and operations.

Current State

reference/mobile_app_demo/ contains the working Flutter proof of concept.
apps/backend/, apps/web/, and apps/mobile/ are reserved for the planned modular project.
The target architecture is contract-first: one OpenAPI contract drives backend interfaces, web types, and mobile clients.
Existing workflow and mobile POC notes have been consolidated into this project-wide documentation set.

Start Here

Goal	Read
Understand product scope	Product Scope, Project Overview
Understand the repository	Repository Structure
Build the full system	Development Workflow, System Architecture
Design or change APIs	API Contracts
Work on asset logic	Domain Model, Event Model
Work on one app	Backend, Web, Mobile
Run, test, or deploy	Local Development, Testing, Deployment
Review finalized process flows	Asset Lifecycle
Check decisions or terminology	ADRs, Glossary

Documentation Map

docs/
├── project/        Product scope, repository shape, delivery workflow
├── architecture/   System architecture, API contracts, domain and events
├── apps/           Backend, web, and mobile implementation notes
├── workflows/      Business process flows and screen-level behavior
├── operations/     Local development, testing, deployment, security, gaps
├── decisions/      Architecture decision records
└── reference/      Data model and glossary

Contribution Rules

Keep docs concise and actionable.
Prefer tables, checklists, commands, and Mermaid diagrams over long prose.
Separate current state from target architecture.
Update docs in the same change as behavior, schema, contract, or workflow changes.
Do not document generated code by hand; document the generator and source of truth.