Feature Documentation Inventory (Current State)
This page maps the existing documentation in @attunelogic-docs to high-level feature areas across:
@attunelogic-api@attunelogic-service@attunelogic-mobile
It is meant as an internal guide for developers and product when deciding where to add or refine docs.
Feature Areas vs Existing Docs
| Feature Area | Repo(s) | Existing Docs | Gaps / Notes |
|---|---|---|---|
| Authentication & Multi-Tenancy | API, Service, Mobile | developer/api/authentication, developer/architecture/multi-tenant, developer/development/authentication-quick-reference, mobile MASTER_ROADMAP | Good coverage of backend auth & tenancy; limited mobile-specific auth UX docs; no consolidated “end-to-end auth flow” doc yet. |
| Core Job/Load Model (Trucking + Service) | API, Service | developer/api/core-features, developer/development/job-management, developer/development/service-operations, API models.md | Conceptual job model covered; trucking-specific load/leg behavior not broken out as its own doc; no explicit “Job vs Leg vs ServiceItem” comparison. |
| Legs & Routes (Trucking) | API, Service, Mobile | Service docs in attunelogic-service/docs/JOB_LEG_CREATION.md and FILE_PROCESSOR.md (outside this repo), developer/api/schedule (partial) | No dedicated doc in @attunelogic-docs describing trucking leg model, routes, and how they’re used by web and mobile; high-priority for trucking-loads-and-legs. |
| Scheduler / Dispatch | API, Service, Mobile | developer/api/schedule, developer/architecture/task-system-architecture (partial), Service SCHEDULER_COMPONENT.md in app repo | Core scheduler component is documented in the Service repo; @attunelogic-docs has API-level schedule docs but no unified trucking dispatch storyline (web + mobile). |
| Quotes / Proposals / Estimates | API, Service | developer/development/service-operations (service quotes/work orders), API quote mixin referenced in code, customer proposal emails (no dedicated doc) | No first-class trucking quote/load-quote doc; proposals are described mostly in service-repair context; conversion from quote → load is not documented. |
| Notifications & Communication | API, Service, Mobile | attunelogic-api/docs/MASTER_ROADMAP (notification section), some NotificationContext notes in Service code; mobile push is documented in mobile repo | @attunelogic-docs has no consolidated notification system doc yet; would be a cross-industry feature. |
| Equipment & Maintenance | API, Service, Mobile | developer/api/equipment-management, developer/development/service-operations (maintenance items), mobile equipment screens (no central doc) | Basic API and service docs exist; mobile equipment behavior and cross-platform flows are not described. |
| Task / Work Item System | API, Service, Mobile | developer/features/task-management-system, developer/features/task-implementation-plan, developer/architecture/task-system-architecture | Good high-level coverage; still mostly architecture/plan focused; less “what’s actually in production today”. |
| PDF & Document Generation | API, Service | developer/api/core-features (PDF mentions), Service FILE_PROCESSOR.md and invoice/receipt docs in app repo | No single doc in @attunelogic-docs summarizing the PDF/email system and how it’s used end-to-end. |
| Testing & Quality | API, Service, Mobile | developer/testing/* (strategy, shift-testing, comprehensive guides), API MASTER_ROADMAP testing notes | Good high-level guidance; not feature-specific; tests vs features mapping is implicit. |
| Deployment & Environments | API, Service, Mobile | developer/deployment/*, API DEPLOYMENT_READINESS_REPORT.md (in API repo), mobile DEPLOYMENT.md | Solid backend + web deployment docs; mobile deployment/CI mostly lives in the mobile repo; not yet centralized here. |
| Mobile App – General | Mobile | attunelogic-mobile/docs/MASTER_ROADMAP, attunelogic-mobile/docs/ROADMAP, INSTALLATION_GUIDE.md | Mobile docs live in the mobile repo; @attunelogic-docs does not yet summarize mobile behavior by feature (dashboard, jobs, legs, equipment, etc.). |
| Mobile App – Trucking Driver Experience | Mobile | Mobile components (Dashboard, DriverLoads, LoadShow, LegCard) and MASTER_ROADMAP trucking section | No dedicated doc here; to be introduced as mobile-trucking-driver-experience. |
Planned Feature-Status Docs (First Wave)
The first wave of detailed, current-state docs will focus on trucking and live under docs/developer/features/:
trucking-loads-and-legs.mdtrucking-dispatch-scheduler.mdtrucking-quotes-and-proposals.mdmobile-trucking-driver-experience.md
These will link back to existing API/Service/Mobile docs where appropriate, and will serve as the canonical “what’s implemented today” references.