DealSphere Platform Documentation¶
Welcome to the official docs for the DealSphere platform. This documentation is the single source of truth for all architecture decisions, technical implementation details, product requirements, QA/test coverage, and delivery planning.
📚 Documentation Structure¶
- Architecture Decision Records (ADRs)
- Trace all critical technology and architecture decisions.
- Find each ADR and the ADR Master Index for rationale/history.
- Planning
- Contains weekly epics table (phase1-epics.md), delivery plans, phase breakdowns, and milestone maps.
- BRD Repository - Business Requirements Documents
- Tech Spec Repository - Technical Specifications
- Product
- Contains Product Requirements Documents (PRDs) and feature specs, versioned per release.
- QA & Compliance
- End-to-end acceptance criteria, functional test cases, traceability matrix, and compliance documentation.
- Technical Documentation
- Implementation plans, technology landscape overviews, demo/release guides, and the release process.
🔗 Quick Navigation¶
- ADR Master Index
- Phase 1 Epics and Delivery Plan
- Phase 1 Product Requirements (PRD)
- Functional Test Cases
- Tech Landscape (MVP)
- Release Process
- Phase 1 Technical Plan
See each subdirectory for additional documentation, internal guides, and implementation notes.
When in doubt, start with the README in that folder.
🚦 Contributing¶
- Propose process/architecture changes by adding an ADR or PR and cross-linking related documentation.
- Follow ADR-0000-template for major decisions, and respect doc/file naming conventions.
- Keep language concise and always map changes to existing PRD, planning, and QA docs.
💡 Getting Help¶
- If unsure, review ADRs and planning/technical docs for context.
- For process/feature/test traceability, follow the links above or contact the core platform team listed internally.
Last updated: August 2025 – All core tech, planning, and QA documentation is actively maintained during MVP delivery.