Design Documents¶
Index of design documents for PlexusOne Desktop features and architecture.
Current Documents¶
Core Platform¶
| Document | Description | Status |
|---|---|---|
| PRD | Product Requirements Document | Active |
| TRD | Technical Requirements Document | Active |
Features¶
| Document | Description | Status |
|---|---|---|
| Mobile App PRD | Mobile companion app design | In Progress |
| AgentPair Design | AgentPair integration analysis | Planned |
| Sentinel PRD | Agent monitoring feature | Planned |
| VoiceNote PRD | Voice note integration | Planned |
Implementation¶
| Document | Description | Status |
|---|---|---|
| Scrollbar Research | Terminal scrollbar investigation | Completed |
| Scrollbar TRD | Scrollbar fix implementation design | Completed |
Document Structure¶
Product Requirements Document (PRD)¶
PRDs define what we're building and why:
# Feature Name PRD
## Problem Statement
What problem are we solving?
## Goals
- Primary objectives
- Success metrics
## Non-Goals
What we're explicitly not doing
## User Stories
As a [user], I want to [action] so that [benefit]
## Requirements
### Functional Requirements
### Non-Functional Requirements
## Design
High-level design approach
## Open Questions
Unresolved decisions
Technical Requirements Document (TRD)¶
TRDs define how we're building it:
# Feature Name TRD
## Overview
Technical summary
## Architecture
- System diagram
- Component responsibilities
- Data flow
## API Design
- Endpoints
- Message formats
- Error handling
## Implementation Plan
- Phases
- Dependencies
- Risks
## Testing Strategy
- Unit tests
- Integration tests
- Performance tests
Creating New Documents¶
When to Write a Design Doc¶
Write a design doc when:
- Adding a significant new feature
- Making architectural changes
- Introducing new dependencies
- Changing external interfaces
Process¶
- Create draft in
docs/design/ - Name format:
FEAT_<NAME>_PRD.mdorFEAT_<NAME>_TRD.md - Review with stakeholders
- Iterate based on feedback
- Approve before implementation
- Update as implementation reveals new information
Template¶
Create new PRDs using this structure:
# [Feature Name] PRD
**Author:** [Your name]
**Status:** Draft | Review | Approved | Implemented
**Created:** YYYY-MM-DD
**Updated:** YYYY-MM-DD
## Problem Statement
[Describe the problem]
## Goals
1. [Goal 1]
2. [Goal 2]
## Non-Goals
- [Non-goal 1]
## Background
[Context and prior art]
## Proposed Solution
[High-level approach]
## Detailed Design
[Specifics]
## Alternatives Considered
### Alternative 1
[Description and why rejected]
## Open Questions
- [ ] Question 1
- [ ] Question 2
## References
- [Link 1]
Archived Documents¶
Documents for completed or abandoned features are moved to docs/design/archive/.
Related¶
- Architecture - System architecture overview
- Contributing - How to contribute