Kvalitní dokumentace je základem udržitelnosti

Autoři frameworku se starají nepřetržitě o systém od roku 2000. Dost dlouhá doba, aby věděli, jak moc na dokumentaci záleží.

Architektem sytému je školitel analýz a architektury, takže mu na kvalitě návrhu i jeho dokumentace záleželo i po odborné stránce.

UML / ArchiMate / E-R modely

Framework i business moduly mají kvalitní udržované modely. Téměř všechna funkcionalita byla nejprve analyzována a zdokumentována, pak teprve naprogramována.

Na kvalitním modelu se dáváme záležet, protože víme, že za 3, 5, nebo i 10 let je to to jediné, o co se dá při správě opřít. Ostatně už po 3 letech si autoři nepamatuji, co a jak dělali.

Řada schémat z model systému je [součástí technické, dokumentace, např. zde](Stateless architektura back-endu umožňuje nejenom snadnou rozšiřitelnost, ale díky ní je kód i celá aplikace mnohem robustnější. V neposlední řadě řešení i šetří zdroje na serveru. Stateless architektura je efektivní i pro aplikace u uživatelů, které jsou díky ní rychlejší, robustnější a mohou snadno nastartovat i po dočasném odpojení od internetu. I to je jeden z důvodů, proč je aplikace v AyMINE velmi svižná - server ji jednoduše nezdržuje.). Díky předchozí zkušenosti víme, že kvalita modelu přesahuje naprostou většinu korporátních aplikací. Ne rozsahem, ale použitelností.

Dokumentovaný kód

Metrika objemu dokumentace kódu je často hodnocenou veličinou, která určuje celkovou kvalitu kódu. Proto je asi nejlepší uvést pár čísel:

• Dokumentaci má 95% metod (platí pro Back-End i Front-End)
• Jednotlivé vstupní parametry a výstupní hodnoty má dokumentováno 90% publikovaných metod, 70% interních (privátních metod)
• 100% dokumentační pokrytí mají rozhraní mezi Back-Endem a Front-Endem
• 100% pokrytí mají globální objekty (objekty používané napříč systémem)
• Celkový objem dokumentace vzhledem ke kódu je přes 35%
• V back-end ani Front-End nejsou kódy, kde by nebyly komentáře alespoň po 10 řádcích kódu

Stejnou úroveň dokumentace má i datový model.

(Ukázka z dokumentace aplikace.)

Dokumentace v angličtině

Až na výjimky je celá dokumentace i kód v angličtině. Není proto problém spolupracovat v mezinárodním týmu.