Documentation

Two parallel tracks: business-focused (people and processes) and technical (architecture and code-level reference).

Business documentation

For ops, training, onboarding, executives.

00

Business Overview

What the system is in plain English, capabilities, glossary.

01

User Roles

Personas with day-in-the-life flows and user stories per role.

02

Permissions Matrix

Who can do what — permission grid by module across all roles.

03

Business Processes

Every workflow end-to-end with state and sequence diagrams.

04

Features by Module

Screen-by-screen prose description of every UI area.

05

Reporting & Insights

The 6 reports — what each answers and who uses it.

06

Localization & RTL

Bilingual support, RTL, admin-editable translations.

Technical documentation

For engineers — code-level reference.

00

System Overview

Architecture, glossary, top-level capabilities.

01

Backend Architecture

DI, MediatR, RBAC, exception handling, JWT.

02

Backend Modules

Every module: entities, handlers, business rules.

03

Database Schema

Every column, type, index, and FK across all tables.

04

Frontend Architecture

Bootstrap, routing, guards, theming, services.

05

Frontend Features

Screen-by-screen frontend implementation detail.

06

Operations

Build, configuration, seeding, deployment.

07

API Reference

Every endpoint with permission and request/response shape.