morethanadiagnosis-hub/openspec/templates/proposal-template.md
2025-11-17 22:57:40 +00:00

1.5 KiB
Raw Permalink Blame History

Proposal:

Status: draft Authors: <names/handles> Owners: <approvers/maintainers> Created: Scope: spec|infra|policy|process Related: <links to issues/PRs/specs>

Summary

  • One paragraph that states the problem, the audience, and the outcome.

Motivation

  • Why this matters to our community (especially those with chronic/terminal illness). Link data or feedback.

Goals / NonGoals

  • Goals: …
  • NonGoals: …

User Stories

  • As a , I want … so that …

Requirements

  • Functional: …
  • Accessibility: WCAG 2.2 AA+ requirements …
  • Privacy & Compliance: PHI/PII boundaries, HIPAA/GDPR notes …
  • Performance/SLOs: …

Architecture & Design

  • System overview and component boundaries
  • Data model updates (ERD snippet or tables)
  • API design (OpenAPI excerpt or endpoints)
  • Feature flags / configuration

Security & Threat Model

  • Trust boundaries, principal actions, abuse cases, mitigations

Observability & Telemetry

  • Logs/metrics/traces; PII/PHI handling policy

Migration / Rollout Plan

  • Data migration steps, backfills, dryrun plan
  • Rollout stages, monitoring, rollback

Test Plan

  • Unit, integration, E2E, accessibility checks

Risks & Mitigations

Alternatives Considered

  • … and why not chosen

Work Breakdown

  • Milestones and tasks with owners

Acceptance Criteria

  • Checkable criteria that define done

Open Questions

Slash Commands

  • /review areas=accessibility,compliance,security,mobile,web,backend
  • /apply spec=openspec/specs/<target-file>.md once approved
  • /archive link=<PR> after merge