Skip to content

Decision Management ​

This directory manages decisions that need to be made throughout the project lifecycle.

Decision Types ​

1. Pending Decisions (pending/) ​

Decisions that need to be made but haven't been resolved yet. These use sequential ADR numbering and are referenced from requirements and specifications.

2. Architecture Decision Records (root directory) ​

Completed decisions using the ADR format, stored as adr-XXX-title.md in the root decisions directory.

Decision Workflow ​

File Naming Convention ​

  • Pending: pending/adr-[number]-[kebab-case-title].md
  • Completed ADRs: adr-[number]-[kebab-case-title].md

Template Usage ​

Integration with Requirements ​

Reference pending decisions in requirements using:

markdown
- Audit trail implementation (see [Decision: Audit Trail Strategy](./adr-001-audit-trail-strategy.md))

Decision Status Tracking ​

Pending Decisions ​

  • Pending: Decision not yet made, initial state
  • In Progress: Under active discussion, research, and analysis
  • Completed: Decision made, ready to move to root directory

Completed ADRs ​

  • Completed: Decision implemented and documented
  • Superseded: Decision replaced by a newer decision

Quick Commands ​

The dashboard auto-updates via hot reload, so you mainly need:

bash
# Check deadlines (quick terminal view)
make check

# Create a new decision with proper numbering
make create

πŸ“Š For status and metrics, just check the auto-updated dashboard at decisions/index.md

Tools & Automation ​

Decision Dashboard ​

  • File: index.md - Automatically generated overview
  • Auto-updates: Via hot reload during development, during build for production
  • Features: Status tracking, deadline monitoring, metrics

Command Line Tools ​

  • Quick deadline check: make check (for terminal-based workflows)
  • Decision creation: make create (handles ADR numbering)
  • Dashboard: Auto-updates via hot reload (no manual commands needed)

Templates ​

  • Pending Decision: templates/pending-decision-enhanced.md
  • ADR: templates/adr-template.md

Current Structure ​

decisions/
β”œβ”€β”€ adr-006-handover-flow-design.md      # βœ… Completed decisions
β”œβ”€β”€ adr-007-heartbeat-frequency.md       # (flat, sequential)
β”œβ”€β”€ index.md                             # πŸ“Š Auto-updated dashboard
β”œβ”€β”€ pending/
β”‚   └── adr-001-audit-trail-strategy.md  # πŸ”„ Pending with ADR numbers
└── templates/                           # πŸ“ Templates
    β”œβ”€β”€ adr-template.md
    └── pending-decision-enhanced.md

For detailed usage, see QUICK-START.md.

Internal use only