π οΈ Design Docs
| Title | Author | Status | Date βΌ |
|---|---|---|---|
| Feature Spec β Notify Me & Categories | relbns | draft | 2026-07-14 |
| Design Doc β Notification Service v1 (event-publish daily digest) | relbns | draft | 2026-07-02 |
| Design Doc: Add to Calendar (superco-consumer) | baruchiro, Bar Levy | shipped | 2026-06-18 |
| Design Doc: Withdrawals Report | relbns | draft | 2026-06-18 |
| Design Doc: Integration Lifecycle Management | relbns | draft | 2026-06-09 |
What lives here: Engineering Design Documents β R&D's translation of a PRD into implementation. The HOW that complements the PRD's WHAT.
Use vs. siblings: a PRD is product's WHAT/WHY; a Design Doc is engineering's HOW. An ADR records a single decision; a Design Doc is broader, scoped to a whole feature.
Template: Design Doc Β· filename:
docs/designs/<slug>-<cu-id>.mdHow it gets written: R&D runs
/plan-featureagainst a PRD that has reachedready-for-rd. The command produces a draft; R&D refines.
Every Design Doc traces back to a PRD via related_prd in frontmatter. Every task in Β§13 Task Breakdown becomes a GitHub Issue via /breakdown, each labeled with the parent ClickUp task.
Lifecycleβ
| Status | What it means |
|---|---|
draft | First pass written, perhaps by /plan-feature. R&D refines. |
in-review | Architecture-level review (architect agent + human). |
approved | Design is locked. Tasks can be broken out and assigned. |
in-progress | Engineering building. |
shipped | All Β§16 Definition of Done items checked. |
deprecated | Replaced by a newer Design Doc; linked to its successor. |
Active Design Docsβ
Browse the sidebar.
- Integration Lifecycle Management β operator self-service add/edit of integrations on the existing two-collection layout (v1.5 bridge).
draft. - UI Design β Event Categories, Phase 1 (Admin Categories) β design-system-anchored UI handoff for the Categories admin screen, anchored to the canonical Claude-artifact design (CU-86c1p963g).
draft. - Add to Calendar (superco-consumer) β the event-page "Add to my calendar" modal: what each button does, supported clients, and the UTC-strict timezone decisions (ICS + the
outlook.office.comOffice 365 button) that settled the Sonoma bugs (CU-86caajc1e).shipped. - Withdrawals Report β read-only community-admin finance report (per-event withdrawals for one month) mostly assembled from existing platform parts.
draft. - Notification Service v1 (event-publish daily digest) β daily digest of new events matched to residents' existing interests, behind a scoped feature flag; decoupled from the category consolidation via a pluggable audience-selector. Self-contained, implementable (CU-86c1p963g / CU-86cafrhcy).
draft. - Feature Spec β Notify Me & Categories β umbrella spec for the whole feature: one
notify-categoriescollection (types Γ up to 3 levels, aliases embedded), keys on residents (notify_categories) and events (custom_filters_keys), governance (L1/L2 canonical, L3 dynamic), phasing (greenfield POC β conditional Phase 0), and the platform feature-flag. The schema derives from it (CU-86c1p963g).draft.
Don't start from scratch. Run /plan-feature docs/prds/<slug>-<cu-id>.md β it reads the PRD, resolves UI Composition against @bewith-dev/design-system's COMPONENTS.md, and produces a Design Doc draft with Β§5 (API), Β§6 (Components), Β§7 (Observability), and Β§13 (Tasks) populated.