Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Where to document database schema in arc42?

I want to document a software project using the arc42 template. Where can I document the database schema? Is it a building block, so it has to be part of chapter 5 (Building Block View)?

like image 407
chrikoch Avatar asked Feb 10 '14 15:02

chrikoch


2 Answers

Explain it in chapter 8 (concepts), section "Persistence":

There you both clarify your

  • persistence strategy and implementation approach, and
  • data model and mapping to internal objects/building-blocks/domain-entities or whatever you use.

I suggest to keep chapter 4 (solution strategy) as brief as possible - better include links to later chapters.

like image 54
gernotstarke Avatar answered Nov 20 '22 02:11

gernotstarke


I'd recommend that it belongs to

  1. Chapter 4 (Solution strategy) where you describe why you chose a DB to solve your problem and
  2. Chapter 9 (Architecture Decisions) documenting how you arrived at that specific DB schema.

So it does not explicitly belong to the building block view.

like image 44
PsiX Avatar answered Nov 20 '22 01:11

PsiX