Softwarová dokumentace a její principy: Průvodce pro studenty
Klepni pro otočení · Swipni pro navigaci
15 kartiček
Otázka: Co je minimální sada dokumentace pro systém z pohledu UC-driven přístupu (z hlediska softwarového inženýrství)?
Odpověď: Use case (funkční pohled), UML diagram tříd/objektů s balíčky (statický pohled) a UML sekvenční diagram (dynamické chování).
Otázka: Proč autor preferuje minimalistický přístup k dokumentaci v softwarovém inženýrství?
Odpověď: Protože považuje za efektivní a minimalizuje množství dokumentace, kterou je třeba udržovat a aktualizovat, čímž se snižuje riziko nekonzistence a chy
Otázka: Jaký problém vzniká s narůstajícím množstvím dokumentace v softwarovém projektu?
Odpověď: Více dokumentace a opakovaných informací na více místech znamená větší nároky na aktualizace a vyšší riziko nekonzistence informací a chybovosti prost
Otázka: Jaký je postoj k dokumentaci databáze podle textu?
Odpověď: Databázovou dokumentaci autor nezmiňuje, protože předpokládá, že logika je v aplikační vrstvě a databázové schéma by mělo být samo-dokumentované čitel
Otázka: Jaké specializované metody pro dokumentaci architektury zmiňuje text jako příklad vědeckého přístupu?
Odpověď: SEI metody ATAM (Architecture Trade-off Analysis Method) a QAW (Quality Attribute Workshop).
Otázka: Co autor uvádí o existenci dalších pohledů a standardů v dokumentaci softwaru?
Odpověď: Existuje mnoho dalších pohledů, doporučení a standardů, technologicky specifických doporučení a názorů, které text nezmiňuje, protože preferuje minima
Otázka: Kdy stačí jako architektonický dokument pouze ofocený náčrtek z tabule a kdy ne?
Odpověď: Stačí, pokud je doména známá a tým malý; nestačí u velkého/distribuovaného nebo nezkušeného týmu, složité či nové technologie nebo neznámá doména, kde
Otázka: Proč je vhodné okomentovat zdrojový kód i když se to může zdát zbytečné?
Odpověď: Komentáře pomáhají při návratu k projektu po čase, usnadňují týmovou spolupráci a umožňují používat kód jako knihovnu bez nutnosti, aby ostatní viděli
Otázka: Jaký je hlavní přínos kvalitní dokumentace u knihoven?
Odpověď: Umožňuje ostatním používat knihovnu bez znalosti vnitřního fungování; bez dokumentace by byla knihovna těžko použitelná nebo nepoužitelná.
Otázka: Jaké prostředky je vhodné využít pro dokumentaci architektury softwaru?
Odpověď: Modelovací prostředky a CASE nástroje, kreslítka, náčrty na tabuli a doprovodný text; forma může být různá podle projektu.