3. Dokumentace backendu

Question 1

Co by měl obsahovat úvod a přehled dokumentace backendu?

Answer 1

• Stručný popis účelu a funkcí backendové aplikace.
• Obecný přehled architektury a použitého technologického stacku.
• Cíle a rozsah dokumentace.

Question 2

Jaké informace by měla obsahovat sekce architektury a designu v dokumentaci backendu?

Answer 2

• Detailní popis hlavních komponent systému a jejich vzájemných interakcí.
• Vysvětlení použitých designových vzorů a architektonických rozhodnutí.
• Diagramy a modely, které ilustrují strukturu a workflow aplikace.

Question 3

Jaké klíčové informace by měla obsahovat dokumentace konfigurace a nasazení backendu?

Answer 3

• Instrukce pro nastavení a konfiguraci aplikace, včetně závislostí a environmentálních proměnných.
• Podrobný průvodce deploymentem aplikace, včetně kroků pro spuštění na produkčním serveru.
• Popis postupů pro monitorování a logování aplikace.

Question 4

Co by měla obsahovat dokumentace perzistentní vrstvy?

Answer 4

• Schéma databáze včetně diagramů a popisů tabulek a vztahů.
• Historie a popis migrací databáze, včetně migračních skriptů.
• Strategie indexace a další optimalizační techniky pro zlepšení výkonu databáze.

Question 5

Jak by měla být strukturována dokumentace API služeb?

Answer 5

• Kompletní seznam API endpointů s popisem URL, podporovaných HTTP metod a očekávaných odpovědí.
• Detailní popis parametrů, formátů dat a návratových typů.
• Příklady volání API, včetně autentizace a autorizace, s praktickými příklady použití.