research.md 2.3 KB

Research & Design Decisions Template


Purpose: Capture discovery findings, architectural investigations, and rationale that inform the technical design.

Usage:

  • Log research activities and outcomes during the discovery phase.
  • Document design decision trade-offs that are too detailed for design.md.
  • Provide references and evidence for future audits or reuse. ---

Summary

  • Feature: <feature-name>
  • Discovery Scope: New Feature / Extension / Simple Addition / Complex Integration
  • Key Findings:
    • Finding 1
    • Finding 2
    • Finding 3

Research Log

Document notable investigation steps and their outcomes. Group entries by topic for readability.

[Topic or Question]

  • Context: What triggered this investigation?
  • Sources Consulted: Links, documentation, API references, benchmarks
  • Findings: Concise bullet points summarizing the insights
  • Implications: How this affects architecture, contracts, or implementation

Repeat the subsection for each major topic.

Architecture Pattern Evaluation

List candidate patterns or approaches that were considered. Use the table format where helpful.

Option Description Strengths Risks / Limitations Notes
Hexagonal Ports & adapters abstraction around core domain Clear boundaries, testable core Requires adapter layer build-out Aligns with existing steering principle X

Design Decisions

Record major decisions that influence design.md. Focus on choices with significant trade-offs.

Decision: <Title>

  • Context: Problem or requirement driving the decision
  • Alternatives Considered:
    1. Option A — short description
    2. Option B — short description
  • Selected Approach: What was chosen and how it works
  • Rationale: Why this approach fits the current project context
  • Trade-offs: Benefits vs. compromises
  • Follow-up: Items to verify during implementation or testing

Repeat the subsection for each decision.

Risks & Mitigations

  • Risk 1 — Proposed mitigation
  • Risk 2 — Proposed mitigation
  • Risk 3 — Proposed mitigation

References

Provide canonical links and citations (official docs, standards, ADRs, internal guidelines).

  • Title — brief note on relevance
  • ...