AquaX Documentation

Owner: Product & Engineering
Reviewers: TBD
Status: Active
Version: 1.2
Last Updated: 2026-09-17
Review Cycle: Per release or major architecture change

This directory is organized into the 10-part project documentation structure for AquaX. The current source of truth is the repository code plus confirmed documents under docs/current/ and docs/01_PRD — Product Requirements Document.md.

Structure

Part	Folder	Purpose
01	`01-product/`	PRD, roadmap, business, functional, non-functional requirements, epics and user stories.
02	`02-project/`	Project overview, milestones, RACI, risks, dependencies and decision log.
03	`03-design/`	User flows, UX requirements and design system notes.
04	`04-architecture/`	System, database, API, integration and security architecture.
05	`05-development/`	Development workflow, git flow, coding, commits, PR, review, DoR and DoD.
06	`06-testing/`	Test strategy, plan, cases, regression, bug workflow, UAT and report template.
07	`07-devops/`	Environments, infrastructure, CI/CD, deployment, rollback, release and config management.
08	`08-security/`	Security policy, access control, secrets, audit logging, backup, vulnerability and incident response.
09	`09-operations/`	Runbook, monitoring, logging, alerting, troubleshooting, DR and maintenance.
10	`10-release/`	Release process, checklist, notes, changelog, handover and validation.

Source Rules

CONFIRMED means matched to repository code or an existing current document.
PARTIAL means implemented in part, with known gaps captured in the PRD or gap log.
PLANNED means the requirement remains valid but is not implemented in current code.
TBD means ownership, process or production detail still needs a project decision.

Canonical References

Reference	Role
`01_PRD — Product Requirements Document.md`	Product requirements baseline, updated to match current implementation status.
`02_BRD — Business Requirements Document.md`	Business requirements baseline derived from current PRD, SRS and 10-part docs.
`03_SRS — Software Requirements Specification.md`	Software requirements baseline derived from legacy SRS, current PRD, BRD and split requirement docs.
`04_ERD — Database Design.md`	Database design and ERD baseline derived from current Prisma schema and data requirements.
`05_Permission Matrix.md`	Role, scope and access-control baseline aligned with SRS and current backend/web/mobile checks.
`06_User Stories — Product Backlog.md`	Product backlog and user-story baseline derived from PRD, BRD, SRS, permission matrix and roadmap.
`07_Design System.md`	Current-code UI design baseline covering web/mobile tokens, components, patterns and design debt.
`08_API Specification.md`	Current backend API baseline derived from controllers, auth/runtime code and web/mobile API constants.
`09_Deployment Plan.md`	Deployment baseline derived from Compose, Dockerfiles, GitHub Actions, Kubernetes overlays, env examples and release scripts.
`04-architecture/API_Architecture.md`	API runtime and architecture baseline derived from NestJS bootstrap, modules, guards, DTOs and client integration code.
`04-architecture/FE_Architecture.md`	Web frontend architecture baseline derived from React/Vite bootstrap, routes, AppShell, Redux, hooks, services and styling code.
`04-architecture/Mobile_Architecture.md`	Mobile architecture baseline derived from Expo app config, navigation, Zustand auth store, API client, hooks, services and release scripts.
`05-development/Git_Workflow.md`	AquaX Git workflow baseline derived from the ST Git Convention and aligned with branch rules, commitlint, PR template and current CI/CD state.
`Mobile_Build_Release.md`	Mobile build and release baseline derived from Expo app config, Android/iOS release scripts, signing templates and deployment docs.
`01-product/SRS.md`	SRS entry point and legacy SRS traceability inside the 10-part structure.
`current/aquax-current-project-requirements.md`	Current project requirements snapshot.
`current/architecture/backend-architecture.md`	Backend architecture snapshot.
`current/architecture/web-architecture.md`	Web architecture snapshot.
`current/architecture/mobile-architecture.md`	Mobile architecture snapshot.
`current/architecture/iot-mqtt-ingestion-architecture.md`	IoT MQTT ingestion architecture snapshot.
`current/conventions/`	Surface-specific coding conventions.
`current/decisions/`	Existing ADRs.
`DOCUMENTATION-GAPS.md`	Known missing decisions and documentation gaps.

Maintenance

Update the relevant part when code changes alter user-facing behavior, API contracts, data models, deployment topology, security controls, or release process. Historical files in current/, reference/, workflow/, and archived/deleted planning folders are not rewritten unless they are intentionally promoted into the 10-part structure.