docs: establish integrated project memory
This commit is contained in:
37
.project-docs/00-brief/project-positioning.md
Normal file
37
.project-docs/00-brief/project-positioning.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Project Positioning
|
||||
|
||||
## One-line Positioning
|
||||
|
||||
XQKqueue is a lightweight multi-project queueing and call-management system for scenic-area operations.
|
||||
|
||||
## Primary Goal
|
||||
|
||||
The project exists to let visitors take and track tickets, let staff call contiguous queue batches safely, let administrators operate and audit projects, and show public queue status on browser and Android large-screen clients.
|
||||
|
||||
## Target Users / Consumers
|
||||
|
||||
- Scenic-area visitors taking or checking tickets.
|
||||
- Front-line staff issuing tickets and calling queue batches.
|
||||
- Administrators configuring projects, users, history, and operational status.
|
||||
- On-site public displays consuming privacy-safe queue snapshots.
|
||||
|
||||
## Non-goals
|
||||
|
||||
- The Android display is not a general-purpose browser or an administrative client.
|
||||
- Public display and visitor APIs must not expose private ticket fields.
|
||||
- Client-side button state, polling, or audio is not an authority for queue writes.
|
||||
|
||||
## Core Constraints
|
||||
|
||||
- The Go service and PostgreSQL database are the sole write authority.
|
||||
- Ticket creation and call-next correctness is enforced at the service transaction boundary; retryable write endpoints use their documented idempotency and revision contracts.
|
||||
- Public screens must tolerate intermittent connectivity and disclose only allowlisted data.
|
||||
- The dedicated Android display must work without System WebView or a device TTS engine.
|
||||
|
||||
## Quality Bar
|
||||
|
||||
A good solution preserves FIFO and privacy invariants under concurrency, has observable loading/offline/error behavior, remains usable on the target 1920x1080 landscape display, and is covered by server, web, Android, and device-level acceptance checks proportionate to the change.
|
||||
|
||||
## Last Reviewed
|
||||
|
||||
2026-08-12
|
||||
29
.project-docs/00-brief/success-criteria.md
Normal file
29
.project-docs/00-brief/success-criteria.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Success Criteria
|
||||
|
||||
## Project Success
|
||||
|
||||
- Visitors can obtain and privately track valid tickets without duplicate or privacy regressions.
|
||||
- Staff can call the correct contiguous FIFO batch by ticket count or people count.
|
||||
- Administrators can configure projects and inspect operational/history data.
|
||||
- Browser and Android public displays show current batches and forecasts without exposing personal data.
|
||||
- The dedicated Android project screen announces each new number or range three times without relying on WebView or system TTS; the overview remains silent.
|
||||
|
||||
## Task Completion Standard
|
||||
|
||||
- Requested behavior is implemented at the correct authority boundary and regression-tested.
|
||||
- Relevant server, web, Android, packaging, and documentation checks pass.
|
||||
- User-visible binaries and their documented checksums match the verified build.
|
||||
- An independent read-only review reports no unresolved P0/P1 finding.
|
||||
- The task record and project documentation gate are complete before handoff.
|
||||
|
||||
## Quality Checks
|
||||
|
||||
- Server: `cd server && go test ./...` and, for database behavior, `scripts/test-postgres.sh` or `make smoke-real`.
|
||||
- Web: `pnpm --dir web test:run`, `pnpm --dir web typecheck`, and `pnpm --dir web build`.
|
||||
- Android: `android\\gradlew.bat clean testDebugUnitTest lintDebug assembleDebug` with `ANDROID_HOME` configured.
|
||||
- APK: verify version metadata, v1/v2 signature, embedded resources, and SHA-256 against `deliverables/android/SHA256SUMS.txt`.
|
||||
- Hardware-dependent display and audio changes require acceptance on the target television; host tests are necessary but not sufficient.
|
||||
|
||||
## Last Reviewed
|
||||
|
||||
2026-08-12
|
||||
Reference in New Issue
Block a user