Proč to děláme

Výchozí problém

Současná e-shopová realita je typicky "peklo", kde jsou produktová data smíchaná dohromady:

  • produkt, cena, sklad a texty žijí v jedné tabulce nebo v nejasně provázaných strukturách,
  • importy přepisují něco, co nemají přepisovat,
  • není jasné, co je zdroj pravdy,
  • lokalizace, SEO a merchandising se lepí na data dodatečně,
  • změna jedné oblasti rozbije jinou,
  • nikdo si už není jistý, co se smí a nesmí.

To vede k tomu, že každá další změna zdražuje vývoj a zvyšuje riziko špatného návrhu.

Cíl tohoto projektu

Cílem není jen "mít nové products API". Cílem je zavést čitelný model, který:

  • odděluje domény a zodpovědnosti,
  • jasně říká, kde je zdroj pravdy,
  • dovolí bezpečně stavět další části platformy,
  • snižuje riziko návratu ke starým anti-patternům,
  • dává týmu oporu při návrhu nových funkcí.

Proč je dokumentace kritická

Tyto stránky nemají být jen popis kódu. Mají sloužit jako ochranná vrstva proti špatným rozhodnutím.

Prakticky to znamená:

  • když někdo navrhuje změnu, musí rychle dohledat, co se v dané doméně smí a nesmí,
  • když někdo nezná celý kontext, musí pochopit, proč model vypadá právě takto,
  • když se přidává nová funkcionalita, musí být jasné, do které vrstvy patří.

Co je zde důležitější než detail implementace

V první fázi je důležitější udržet správné hranice systému než mít vyřešené všechny endpointy.

Proto dokumentace klade důraz na:

  • hranice domén,
  • zakázané zkratky,
  • zdroje pravdy,
  • vztahy mezi moduly,
  • celkový obraz platformy.