neděle 30. ledna 2022

Starý junior, mladý senior

Seniorita je pojem z oblasti společenských vztahů. Vyjadřuje nadřazenost osoby nebo skupiny na základě vyššího věku nebo délky zastávání určité pozice. Takže senior je buď člověk staršího věku nebo pracující déle na nějaké pozici. Junior je autonymum.

Tímto příspěvkem se pokusím odpovědět na tyto komplexní otázky:

  • Jak je definována "kvalita vývojáře"?
  • Jak vlastně délka profesní kariéry souvisí s vlastní kvalitou vývojáře?

Dlouho jsem přemýšlel nad tím, jak téma uchopit. Nakonec jsem dal dohromady několik vstupů:

  • moje pozorování kolegů a toho, co se mi na jejich profesním chování líbí,
  • reakce lidí na můj anketní tweet,
  • seznam znalostí a dovedností, které považuji za důležité.

A výstupem se stal Honza.

Honza je kompendiem zkušeností a profesní efektivity. Je to kombinace mnoha profesních rolí - architekt, analytik, programátor, manažer, projekťák, atd. A také je to někdo, kdo reálně neexistuje. Je to ideál vývojáře, na kterém si zkusíme popsat, co všechno může mít na naši práci pozitivní vliv.

Honzův profil by nám tedy mohl pomoci s odpovědí na první otázku. Na tu druhou si odpovíme ke konci příspěvku.

Honza a práce

Honza je pracovitý a vytrvalý. To je základ.

Nevyhýbá se úkolům. Samozřejmě chápe, že práce bude vždy více než je dostupného času. Snaží se proto správně pracovat s prioritami. Rozumí, že každá záležitost obnáší investici ve formě času a generuje určitou hodnotu. Nenechá se odlákat od aktuálního prioritního úkolu pouze tím, že se právě objevil méně prioritní ale zato atraktivnější úkol.

Umí dotahovat úkoly ke zdárnému konci. Nenechá se odradit překážkami. Je orientovaný na výsledek. Ne však na úkor kvality. Má soubor profesních zásad, které dodržuje i pod projektovým tlakem. Na druhou stranu ví, kdy je z nich možné a vhodné mírně ustoupit a jaké to bude mít důsledky. Ty je potřeba správně komunikovat.

Má vybudované návyky, které mu pomáhají dělat práci efektivně. Umí si den rozdělit do delších bloků hluboké práce bez vyrušování. Umí si organizovat inbox a backlog přes všechny své profesní role. Reaguje na pracovní požadavky podle jejich důležitosti. Umí říkat NE.

Honza a kolegové

S Honzou je příjemné pracovat.

Čím komplexnější projekt, tím větší tým a tím důležitější chemie mezi lidmi. Honza si důležitost vztahů uvědomuje. Je empatický. Chápe rozdíly v typologiích osobností. Dokáže být asertivní.

Nezdůrazňuje svoji senioritu v týmu. Respekt si buduje svojí profesionalitou a tím, že respektuje ostatní. Povzbuzuje své kolegy k samostatnosti a k tomu nebát se zkoušet nové věci a hledat optimálnější řešení. Spoluvytváří pozitivní atmosféru, ve které se všem dobře pracuje. Svůj názor se snaží prosadit věcným způsobem.

Honza je pokorný. Nemá ve zvyku neustále hledat problémy pouze u druhých, když se něco nepodaří. Začně tím, že si vyhodnotí svůj podíl na problému jako první. Chápe, že i on dělal, dělá a bude dělat chyby. Nevymlouvá se, když se mu něco nepovede. Vysvětlí okolnosti, které vedly k jeho chybě a upraví své pracovní postupy a chování tak, aby se stejná chyba v budoucnu neopakovala.

Snaží se konfliktům předcházet a pokud už nastanou, tak je zmírňovat. Pokud něco nefunguje, neuchyluje se k osobní kritice kolegů. Je věcný. Nepomlouvá. Snaží se aktivně hledat příčiny problémů a ty pak konstruktivně řešit. Dokáže konstruktivně přijmout zpětnou vazbu na svoji práci. Pokud sám zpětnou vazbu poskytuje, pak nekonfliktním způsobem. Kolegové tak nemají pocit, že jsou kritizováni, ale že jsou podporováni k lepším výsledkům.

Honza zná základní principy koučinku a umí je v praxi použít. Pomáhá tím kolegům v uvědomění si jejich aktuální profesní situace a toho, kam by se mohli posunout a jakým způsobem. Takto přirozeně tým rozvíjí a pomáhá jeho členy motivovat.

Mluví otevřeně a transparentně. Buduje důvěryhodné prostředí, nemanipuluje s informacemi, poskytuje je všem konzistentním způsobem. Kolegy nezdržuje přílišným tlacháním na poradách.

Honza jako architekt řešení

Honza už chápe, že zákazník na začátku projektu často přesně neví co chce. Honzu netrápí, že nemá často přesné zadání. Chápe to jako příležitost pomáhat zákazníkovi už od začátku s hledáním řešení. Co jej občas trápí je, když se po něm chce estimace příliš hrubého zadání. Je si vědom, že taková estimace v ranné fázi projektu je pouze loterie, která se hraje hlavně proto, aby měl zákazník rámcovou představu o nákladnosti projektu. Nesnaží se dodat konkrétní číslo, ale spíše rozpětí optimistického a pesimistického odhadu. Rozloží si problém na menší celky a ty estimuje zvlášť. Umí zákazníkovi vysvětlit rizika takové estimace a obsažené stupně volnosti.

Honza se snaží aktivně porozumět rizikům projektu. Tato rizika srozumitelně popíše, navrhne protiopatření a vykomunikuje je směrem k zákazníkovi. Zkušenost mu velí, že největší rizika vznikají při integraci aplikace s externími systémy a při závislosti na úkolech, které musí zajisti zákazník sám.

Honza má zkušenosti s agilními projekty i vodopádem. Pracoval v režimu Fix-time-fix-price i Time-&-Material. Dokáže je porovnat z různých perspektiv. Preferuje agilní přistup, ale chápe, že každá metodologie je vhodná pro jiný typ projektu. Chápe, že zadavatel má určitý přístup k řešení projektů, který někdy nelze úplně změnit. Nejdříve si tedy nechá vysvětlit problém, který je potřeba řešit a teprve potom navrhuje typ metodiky. Ne obráceně. Umí vyargumentovat vhodnost jednotlivých přístupů a zohlednit připomínky zákazníka.

Honza zná principy Scrumu, Kanbanu, extrémního programování i vodopádu. Je si vědom, že málokdy se na projektu jedná o jednu striktní metodiku. Často dochází k hybridnímu modelu s prvky více metodik současně. Umí v takovém prostředí fungovat. Dokáže poznat, kdy to způsobuje problémy a kdy naopak to projektu prospívá. Uvědomuje si, že získávání zpětné vazby na práci týmu od zákazníka je klíčové pro úspěch projektu v každé metodice.

Honza jako analytik

Honza dobře chápe, že za vznikem dobrého softwarového produktu je obvykle symbióza správného technického řešení a pochopení byznysových potřeb. Aktivně se snaží porozumět byznysové doméně. Chápe, že jednoznačný doménový glosář redukující používání synonym je základem plynylé komunikace a snižuje míru neporozumění v rámci projektového týmu.

Honza umí naslouchat potřebám zákazníka, pomáhat s návrhem řešení a formalizovat požadovanou funkcionalitu ve formě use cases. Rutinně používá UML a kreslí diagramy případů užití, aktivitní diagramy, sekvenční diagramy a další.

Honza je schopen definovat funkcionální epiky a jejich rozpad na user stories. Nepodceňuje správnou formulaci všech tří hlavních částí story. Rozumí důležitosti formy a obsahu akceptačních kritérií, Definition of Ready a Definition of Done.

Když je na projektu nějaká velká neznámá nebo vysoce komplexní část, umí si s tím poradit. Nepřeceňuje význam verbální diskuze. Pozná, kdy je lepší přestat mluvit a udělat první krok k řešení problémů. Raději udělá první krok špatným směrem, než dlouho váhat a neudělat žádný. I pozdější uvědomění si nesprávného postupu je progres.

Honza nepodceňuje důležitost definice nefunkcionálních požadavků. Aktivně se zákazníkem řeší požadavky na zabezpečení, odezvu systému, propustnost, podporované prohlížeče, apod. Je si vědom toho, že právě tyto záležitosti mají často zásadní vliv na architekturu řešení.

Honza jako technický vedoucí týmu

Honza spolu s týmem nastavuje pravidla pro psaní kódu. Společně integrují nástroje pro statickou a dynamickou analýzu. Sdílejí si týmové šablony a code snippety. Snaží se zajistit rozumnou míru standardizace, která práci celého týmu zefektivňuje.

Honza chápe důležitost automatizace CI a CD procesů. Proto trvá na jejich správném nastavení již od začátku vývoje.

Honzovi je jasné, že správně prováděná code review jsou velkým přínosem pro kvalitu výstupu. Zároveň dbá na to, aby způsob komunikace v rámci review byl profesionální a konstruktivní. Chce, aby to byl proces učení a společného hledání lepšího řešení.

Honza si je vědom, že každý softwarový projekt je postupně zatížen technickým dluhem, se kterým se musí pracovat. Zná postupy jak redukovat míru jeho vzniku už ve fázi návrhu. V týmu aktivně používají Boyscout-rule. Zároveň však dokáže poznat, kdy je už další umořování technického dluhu ekonomicky neefektivní.

Komunikuje technické záležitosti srozumitelným způsobem produkťákům a mecenášům projektu tak, aby zajistil adekvátně robustní řešení. Větší refaktoring domluví jako technickou user story naplánovanou s vědomím zákazníka v souvislosti s funkcionální změnou v souvisejím kódu. Dělat refaktoring bez motivace rozšíření stávající funkcionality nebo optimalizace výkonu nepovažuje za opodstaněné.

Honza nabádá kolegy, aby přicházeli s nápady na vhodné nástroje a knihovny, které by práci na projektu vylepšily. Nejdříve si však jejich použití odprototypují a posoudí jejich přínos. Je přiměřeně konzervativní v použití nových věcí. Mnohokrát již dříve zjistil, že vhodnost technologie se nedá posoudit hned, ale spíše později při aplikaci na komplexnější záležitosti. Použití takové neprověřené technologie považuje za riziko a tak s ním i nakládá.

Honza jako programátor

Anatomii vývojového cyklu specifikace-analýza-návrh-implementace-verifikace má Honza stále v podvědomí. Snaží se tyto fáze ve svých postupech logicky oddělit.

Když začíná pracovat na novém úkolu, začne analýzou problému. Pokud problém obsahuje neurčitost, kterou potřebuje vyjasnit, neváhá sáhnout k prototypování. Udělá rychlý prototyp, který mu pomůže pochopit problém a ukáže možné cesty k řešení problému. Prototyp pak zahodí a nepodléhá lákadlu jeho použítí přímo v produkčním kódu.

Součástí Honzovy analýzy je obvykle také rozpad problému do menších celků. Tyto menší celky jsou pak lépe uchopitelné. Veškeré nejasné a problematické části zadání strukturovaně sepíše a prodiskutuje s autorem požadavku.

Ve fázi návrhu si rád pomůže nakreslením některého z UML diagramů. Pro statický pohled na řešení používá komponentový diagram a diagram tříd. Pro dynamický pohled aktivitní, sekvenční nebo stavový.

Někdy mu také pomůže TDD přístup. Jednotkovými testy postupně definuje rozhraní komponenty a iterativně její sémantiku. Snaží se o konzistentní a dostatečně samopopisný názvy testů, které poslouží jako aktuální dokumentace ke komponentám. Ze složitosti zápisu jednotkových testů dostává okamžitě zpětnou vazbu na návrh komponent a jejich složitost.

Honza si bez jednotkových testů nedokáže vývoj představit. Není však radikálním zastáncem 100% pokrytí kódu u komponent, u kterých je přínos jednotkových testů velmi malý oproti nákladům na jejich vytvoření a údržbu.

Při návrhu komponent používá Honza kombinaci různých best practices a návrhových vzorů. Základem jsou pro něho SOLID principy. Bez použití IoC kontejneru a Dependency Injection si už nedovede své projekty ani představit. Má rád volné vazby mezi komponentami, nízká čísla u metrik závislostí a vysokou soudržnost. Díky tomu může psát testy efektivním způsobem.

Pro Honzu bylo přečtení knížky Clean Code důležitým profesním milníkem. Začal přemýšlet nad svým kódem jinak. Zaměřuje se na dobré pojmenování, zkracuje metody, snižuje cyklomatickou složitost, redukuje parametry, více přemýšlí nad ošetřením možných chybových stavů. Obecně se více dívá na kód z pohledu čtenáře než autora. Zásadní důraz klade na dobrou čitelnost a samodokumentovatelnost kódu. Ovládá nejpoužívanější techniky refaktoringu právě pro dosažení lepší struktury a udržovatelnosti kódu.

Integračními testy si ověří funkčnosti přes celý aplikační stack.

Otázky výkonu Honza řeší již při návrhu architektury. Rozumí také výkonostním aspektům frameworkových komponent a vlastního jazyka. Nenechá se však vlákat do pasti dopředné optimalizace při psaní komponent. Tu provádí až poté, co má nejdříve funkční řešení.

Honza se snaží své hlavní softwarové nástroje ovládat pouze z klávesnice bez nutnosti použití myš. Aktivně se učí klávesové zkratky. Píše bez překlepů. Psaní na klávesnici pravidelně trénuje.

Honzovy znalosti jazyků a technologií

Ve svém hlavním programovacím jazyce se cítí velmi komfortně. Na druhou stranu si uvědomuje, že získat hlubokou expertízu v použití hlavních knihoven platformy je běh na dlouhou trať. Aktivně proto hledá možnosti, jak si zvé znalosti rozšířit. Čte si blogy, porovnává různá řešení stejného problému na Stackoverflow, prototypuje alternativy, diskutuje s kolegy.

Honza má rozsáhlé teoretické znalosti v oblasti softwarového inženýrství. Díky nim dokáže rychleji najít optimálnější řešení problému. Ví co hledá a umí si dát věci do souvislostí.

Má zkušenosti s jazyky a technologiemi napříč celým stackem. Dokáže napsat aplikace běžící na serveru, v prohlížeči i na mobilních zařízeních. Díky takto širokému záběru chápe souvislosti a umí navrhnout správně komunikační rozhranní. Rozumí protokolům REST, GraphQL, gRTC i SOAP.

Honza zná principy hlavních cloudových platforem. Umí navrhnout a nakonfigurovat ideální mix cloudových služeb podle potřeb daného projektu. Rozumí Dockeru a Kubernetes.

Jak dlouho je už Honza v oboru?

A odpověď na druhou otázku je ... Nevím.

Dle mého názoru se délka kariéry v IT často přeceňuje. Já sám znám několik relativně mladých vývojářů, kteří mají k Honzovi blíže než jiní, kteří ještě programovali v Turbo Pascalu. Ale rozhodně z toho nemůžeme dělat pravidlo.

Co můžeme z tak komplexního Honzova profilu tedy vyvodit? Dostat se na vysokou úroveň mnoha dovedností vyžaduje spoustu času stráveného praktikováním. To bezesporu. U některých vlastností jsou navíc nutné i životní zkušenosti, které formují především sociální inteligenci.

Důležitou složkou naší osobnosti jsou charakterově volní vlastnosti. Spolehlivost, pracovitost, zásadovost, ... Jejich správné nastavení má zřejmě zásadní vliv na rychlost profesního růstu.

Velký dopad má také to, v jakém prostředí a týmu se vývojář vyvíjel. Při dobrém vedení se může začínající perspektivní vývojář během krátkého období hodně posunout. Proto je zřejmě výhodné, aby byli mladí ve více flexibilním prostředí s variabilnějšími projekty. Samozřejmě za asistence zkušených kolegů.

Zkusme být jako Honza ...

... ale nestresujme se z toho, že takoví nejsme. Pracujme na sobě. Každý úkol je příležitostí se něco nového naučit, zlepšit se, zkusit jiný postup. Odměnou nám bude dobře odvedená práce a spokojenost. A o to přeci jde.

Vox populi

Tady si můžete přečíst, co si o tématu myslí kolegové z Twitteru. Děkuji všem za reakce.

pondělí 24. října 2016

Jednoduchá složitost nebo složitá jednoduchost

Známe to všichni. Kód, který jsme dříve napsali, byl dobře čitelný a lehce upravitelný. Ten samý kód dneska? Nakynuté třídy, dlouhé metody, vysoká komplexita a zvyšující se náklady na požadované změny.

Všude slýcháme, že musíme psát kód jednoduchý, dobře čitelný, s nízkou komplexitou. Dobře, ale co to vlastně v praxi znamená? Zjistil jsem, že my vývojáři si pod "jednoduchostí kódu" často představujeme dost rozdílné věci.

Pojďme se společně podívat na několik řešení stejného problému a přemýšlet nad tím, co si vlastně pod "jednoduchým kódem" představujeme.

Řešíme "problém života"

Jako ukázkový problém nám poslouží hra Game of Life, kterou zpopularizovaly akce typu Coderetreat. Zrovna minulou sobotu byl Global Day of Coderetreat 2016, takže pro mnohé účastníky čerstvá zkušenost.

Hra definuje několik základních pravidel pro výpočet stavu buňky v příští generaci:

  • Any live cell with fewer than two live neighbours dies, as if caused by under-population. (Under-population rule)
  • Any live cell with two or three live neighbours lives on to the next generation. (Survival rule)
  • Any live cell with more than three live neighbours dies, as if by over-population. (Over-population rule)
  • Any dead cell with exactly three live neighbours becomes a live cell, as if by reproduction. (Reproduction rule)

Výpočet je tedy funkcí aktuálního stavu buňky a počtu jejich živých sousedů. Pravidla nám trochu zatajují situace (Dead,x), kde x in {0,1,2,4,5,6,7,8}. U těch se předpokládá příští stav Dead. Bude pro nás srozumitelnější, když si pro tyto případy zavedeme další "defaultní" pravidlo No-reproduction rule.

Kód je sice v C#, ale to by pro vývojáře ze spřátelených platforem neměl být žádný problém. Jde tady přeci o společné principy čitelnosti, komplexity a OOP.

Testy až na prvním místě

Jak už to u Test-First přístupu bývá, testy nám pomohou lépe pochopit problém a pokrýt celou množinu možných situací. Tento článek ale není o TDD přístupu ani o návrhu struktury testovacích případů. Dovolím si proto zjednodušený zápis finální množiny testů do jednoho parametrického jednotkového testu:

public class NextGenerationStateCalculatorTests
{
    [TestCase(CellState.Live, 0, CellState.Dead, TestName = "Under-population rule: (Live,0) => Dead")]
    [TestCase(CellState.Live, 1, CellState.Dead, TestName = "Under-population rule: (Live,1) => Dead")]
    [TestCase(CellState.Live, 2, CellState.Live, TestName = "Survival rule: (Live,2) => Live")]
    [TestCase(CellState.Live, 3, CellState.Live, TestName = "Survival rule: (Live,3) => Live")]
    [TestCase(CellState.Live, 4, CellState.Dead, TestName = "Over-population rule: (Live,4) => Dead")]
    [TestCase(CellState.Live, 5, CellState.Dead, TestName = "Over-population rule: (Live,5) => Dead")]
    [TestCase(CellState.Live, 6, CellState.Dead, TestName = "Over-population rule: (Live,6) => Dead")]
    [TestCase(CellState.Live, 7, CellState.Dead, TestName = "Over-population rule: (Live,7) => Dead")]
    [TestCase(CellState.Live, 8, CellState.Dead, TestName = "Over-population rule: (Live,8) => Dead")]
    [TestCase(CellState.Dead, 3, CellState.Live, TestName = "Reproduction rule: (Dead,3) => Live")]
    [TestCase(CellState.Dead, 0, CellState.Dead, TestName = "No-reproduction rule: (Dead,0) => Dead")]
    [TestCase(CellState.Dead, 1, CellState.Dead, TestName = "No-reproduction rule: (Dead,1) => Dead")]
    [TestCase(CellState.Dead, 2, CellState.Dead, TestName = "No-reproduction rule: (Dead,2) => Dead")]
    [TestCase(CellState.Dead, 4, CellState.Dead, TestName = "No-reproduction rule: (Dead,4) => Dead")]
    [TestCase(CellState.Dead, 5, CellState.Dead, TestName = "No-reproduction rule: (Dead,5) => Dead")]
    [TestCase(CellState.Dead, 6, CellState.Dead, TestName = "No-reproduction rule: (Dead,6) => Dead")]
    [TestCase(CellState.Dead, 7, CellState.Dead, TestName = "No-reproduction rule: (Dead,7) => Dead")]
    [TestCase(CellState.Dead, 8, CellState.Dead, TestName = "No-reproduction rule: (Dead,8) => Dead")]
    public void Calculate__For_Given_CellState_And_Neighbours__Should_Return_Expected_CellState(CellState cellState, int numberOfLiveNeighbours, CellState expectedNextGenerationCellState)
    {
        var nextGenerationCellState = new NextGenerationStateCalculator().Calculate(cellState, numberOfLiveNeighbours);
 
        Assert.AreEqual(expectedNextGenerationCellState, nextGenerationCellState);
    }
}
 
public enum CellState
{
    Live,
    Dead
}

Ve výsledku tedy máme celkem 2 [součastný stav buňky - Live, Dead] x 9 [počet sousedů 0 .. 8] = 18 testů. Mohli bychom případně udělat rozpad struktury testů podle jednotlivých pravidel. Mohli bychom vylepšit pojmenování. A další. Tím se ale nechci zdržovat. Pojďme řešit implementaci.

A. První verze - ta "nejrychlejší"

Už si nepamatuju, jak jsem na svém prvním Coderetreatu pravidla implementoval já. Často ale vidím, že programátoři napíšou něco takového:

public class NextGenerationStateCalculatorA
{
    public CellState Calculate(CellState cellState, int numberOfLiveNeighbours)
    {
        if (cellState == CellState.Live && (numberOfLiveNeighbours == 2 || numberOfLiveNeighbours == 3)
            || (cellState == CellState.Dead && numberOfLiveNeighbours == 3)) return CellState.Live;
 
        return CellState.Dead;
    }
}

Je to výsledek přístupu "Žij nebo Zemři". Náš pohled na problém je omezen na to, že stačí určit, kdy bude buňka v příští generaci Live. Pro všechny ostatní případy je Dead.

Problémem tohoto přístupu je ignorování narůstající složitosti podmínky pro Live. Případné další pravidlo by při tomto přístupu podmínku ještě více znepřehlednilo. Implementace podmínky také nenese žádnou informaci o tom, jaká pravidla zahrnuje. Není zde žádné mapování kódu na požadavky. Cyklomatická složitost (Cyclomatic Complexity) této implementace je 6. Takže docela dost.

Kód je relativně krátký, ale je snadné jej pochopit a rozšířit? Zkusíme vylepšit expresivitu kódu ...

B. Pomůžeme si pojmenováním proměnných

public class NextGenerationStateCalculatorB
{
    public CellState Calculate(CellState cellState, int numberOfLiveNeighbours)
    {
        var useSurvivalRule = cellState == CellState.Live && (numberOfLiveNeighbours == 2 || numberOfLiveNeighbours == 3);
        var useReproductionRule = cellState == CellState.Dead && numberOfLiveNeighbours == 3;
 
        return useSurvivalRule || useReproductionRule ? CellState.Live : CellState.Dead;
    }
}

V kódu se nám už objevuje terminologie prvních pravidel. Konkrétně Survival a Reproduction. Zavedené lokální proměnné nám tak přidávají do kódu částečnou vazbu na naše zadání. Ostatní pravidla ale v kódu explicitně uvedena nejsou.

C. Strukturujeme kód podle jednotlivých pravidel

public class NextGenerationStateCalculatorC
{
    public CellState Calculate(CellState cellState, int numberOfLiveNeighbours)
    {
        if (cellState == CellState.Live && numberOfLiveNeighbours < 2) return CellState.Dead;
        if (cellState == CellState.Live && (numberOfLiveNeighbours == 2 || numberOfLiveNeighbours == 3)) return CellState.Live;
        if (cellState == CellState.Live && numberOfLiveNeighbours > 3) return CellState.Dead;
        if (cellState == CellState.Dead && numberOfLiveNeighbours == 3) return CellState.Live;
 
        return CellState.Dead;
    }
}

Toto řešení nám sice zvedlo LOC, ale jeho struktura už více kopíruje jednotlivá pravidla. Opět nám však chybí informace o názvu jednotlivých pravidel a CC nám skočila na 10.

D. Extrahujme podmínky pro jednotlivá pravidla

public class NextGenerationStateCalculatorD
{
    public CellState Calculate(CellState cellState, int numberOfLiveNeighbours)
    {
        if (UseUnderPopulationRule(cellState, numberOfLiveNeighbours)) return CellState.Dead;
        if (UseSurviveRule(cellState, numberOfLiveNeighbours)) return CellState.Live;
        if (UseOverPopulationRule(cellState, numberOfLiveNeighbours)) return CellState.Dead;
        if (UseReproductionRule(cellState, numberOfLiveNeighbours)) return CellState.Live;
 
        return CellState.Dead;
    }
 
    private bool UseUnderPopulationRule(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Live && numberOfLiveNeighbours < 2;
    }
 
    private bool UseSurviveRule(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Live && (numberOfLiveNeighbours == 2 || numberOfLiveNeighbours == 3);
    }
 
    private bool UseOverPopulationRule(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Live && numberOfLiveNeighbours > 3;
    }
 
    private bool UseReproductionRule(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Dead && numberOfLiveNeighbours == 3;
    }
}

Extrahovali jsme podmínky pravidel do pojmenovaných privátních metod. Čitelnost se tím trochu zlepšila a snížili jsme CC hlavní metody na 5. Pořád mi ale vadí, že podmínky a výsledný stav jednotlivých pravidel nejsou logicky lépe seskupeny. Takto se nám v kódu 4-krát opakuje stejný pattern:

if (XRule(cellState, numberOfLiveNeighbours)) return CellState.?;

E. Sbližujeme podmínky pravidel a výsledné stavy

delegate bool RulePredicate(CellState cellState, int numberOfLiveNeighbours);
 
public class NextGenerationStateCalculatorE
{
    public CellState Calculate(CellState cellState, int numberOfLiveNeighbours)
    {
        var rules = new Dictionary<RulePredicateCellState>
        {
            { UnderPopulationRulePredicate, CellState.Dead },
            { SurviveRulePredicate, CellState.Live },
            { OverPopulationRulePredicate, CellState.Dead },
            { ReproductionRulePredicate, CellState.Live },
            { NoReproductionRulePredicate, CellState.Dead }
        };
 
        var ruleKeyToApply = rules.Keys.First(rulePredicate => rulePredicate(cellState, numberOfLiveNeighbours));
        var nextGenerationState = rules[ruleKeyToApply];
 
        return nextGenerationState;
    }
 
    private bool UnderPopulationRulePredicate(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Live && numberOfLiveNeighbours < 2;
    }
 
    private bool SurviveRulePredicate(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Live && (numberOfLiveNeighbours == 2 || numberOfLiveNeighbours == 3);
    }
 
    private bool OverPopulationRulePredicate(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Live && numberOfLiveNeighbours > 3;
    }
 
    private bool ReproductionRulePredicate(CellState cellState, int numberOfLiveNeighbours)
    {
        return cellState == CellState.Dead && numberOfLiveNeighbours == 3;
    }
 
    private bool NoReproductionRulePredicate(CellState cellState, int numberOfLiveNeighbours)
    {
        return true;
    }
}

Zadefinovali jsme delegát RulePredicate, který popisuje, jak mají vypadat metody vyhodnocující podmínku pro pravidlo. Dictionary rules mapuje tyto podmínky na výsledné stavy. Máme tak poměrně hezké přiřazení pojmenované podmínky a výsledného stavu pro jednotlivá pravidla. Za tento "funkcionální přístup" jsme odměněni hezkou jedničkou z CC.

Moc se mi ale nelíbí způsob procházení obecného Dictionary, kdy odkazujeme Keys abychom přistoupili k predikátům jednotlivých pravidel. Abstrakce pravidla stále není moc dobrá.

F. Tak dobře, zapouzdříme pravidla

public class NextGenerationStateCalculatorF
{
    private readonly RuleBase[] _rules;
 
    public NextGenerationStateCalculatorF()
    {
        _rules = new RuleBase[]
        {
            new UnderPopulationRule(),
            new SurvivalRule(),
            new OverPopulationRule(),
            new ReproductionRule(),
            new NoReproductionRule()
        };
    }
 
    public CellState Calculate(CellState cellState, int numberOfLiveNeighbours)
    {
        var ruleToApply = _rules.First(rule => rule.Predicate(cellState, numberOfLiveNeighbours));
        var nextGenerationState = ruleToApply.NextGenerationCellState;
 
        return nextGenerationState;
    }
 
    private abstract class RuleBase
    {
        public RulePredicate Predicate { get; }
        public CellState NextGenerationCellState { get; }
 
        protected RuleBase(RulePredicate predicate, CellState nextGenerationCellState)
        {
            Predicate = predicate;
            NextGenerationCellState = nextGenerationCellState;
        }
    }
 
    private class UnderPopulationRule : RuleBase
    {
        public UnderPopulationRule()
            : base((state, neighbours) => state == CellState.Live && neighbours < 2, CellState.Dead)
        { }
    }
 
    private class SurvivalRule : RuleBase
    {
        public SurvivalRule()
            : base((state, neighbours) => state == CellState.Live && (neighbours == 2 || neighbours == 3), CellState.Live)
        { }
    }
 
    private class OverPopulationRule : RuleBase
    {
        public OverPopulationRule()
            : base((state, neighbours) => state == CellState.Live && neighbours > 3, CellState.Dead)
        { }
    }
 
    private class ReproductionRule : RuleBase
    {
        public ReproductionRule()
            : base((state, neighbours) => state == CellState.Dead && neighbours == 3, CellState.Live)
        { }
    }
 
    private class NoReproductionRule : RuleBase
    {
        public NoReproductionRule()
            : base((state, neighbours) => trueCellState.Dead)
        { }
    }
}

Hlavní metoda prohledá pole pravidel inicializovaných v konstruktoru třídy. Vybraného pravidla se pak zeptá na příští stav. CC = 1. Při implementaci jednotlivých pravidel jsme si pomohli bázovou třídou RuleBase. Implementace konkrétního pravidla se nám pak omezí pouze na předání predikátu a nového stavu přes volání bázového konstruktoru.

Každé pravidlo je nyní reprezentováno dobře pojmenovanou třídou. Hlavní třída pouze definuje pořadí těchto pravidel a umí se doptat na výsledný stav buňky v příští generaci. Celková komplexita problému je rozložena do více tříd s nízkou komplexitou. Přestože je kód delší, můžeme jej stále považovat za jednoduchý.

Jak tedy psát ten kód?

Možná si říkáte, kam jsme se to v tom vylepšování až dostali. Proč tak složitě na tak jednoduchý problém? Proč vytvářet tolik tříd?

Je to trénink. Test toho, jak vnímáme komplexitu kódu a které charakteristiky nás vlastně zajímají. Reálné problémy jsou samozřejmě složitější a správná redukce komplexity přinese výraznější benefity. A příjemnější práci pro programátory.

Přemýšlejme nad každým větvením programu, zda-li se náhodou nejedná o signál pro použití polymorfismu a separaci na úrovni tříd. Nízká CC by měla být našim základním požadavkem.

Preferujme, aby v našem kódu byla snadno dohledatelná struktura reálného problému, tedy našich (správně formulovaných) požadavků.

Nejrychlejší / nejkratší řešení často nebývá nejlepší. Zvažujme různé možnosti a přístupy. Psát "složitý kód" bývá jednoduché, zato psát "jednoduchý kód" často složité.

Strach, lenost nebo neschopnost problém dekomponovat do více jednodušších tříd často vede k hromadám špaget. Nic proti špagetám, mohl bych je mít pořád. Ale v kódu se bez nich rád obejdu! :)

neděle 28. února 2016

Požadavky na požadavky

Primárním cílem každého software je řešit problémy zákazníka nebo své cílové skupiny. Řešení je popsáno specifikací požadavků na systém. Psát dobré požadavky a efektivně je spravovat není snadné. Vyžaduje to specifické dovednosti a spolupráci napříč celým týmem. Dobrá specifikace je ale stejně důležitá jako dobrý zdrojový kód.

Pojďme se společně podívat, jaké problémy nám mohou komplikovat práci s požadavky.

Tohle není můj problém

Programátor: “Od analytiků dostáváme hrozné zadání. Jak podle toho máme něco naprogramovat!?”

Analytik: “Vykomunikoval jsem to se zákazníkem, popsal hlavní ideu, navrhl postup a tím to pro mě končí. Programátoři ale chtějí, abych za ně promýšlel problém do úplných detailů. To je jejich práce. Na to nemám čas.”

Pokud mají dvě skupiny v naší firmě potřebu se vzájemně vyhraňovat, máme dost závažný problém. Týmové role nespolupracují efektivně. Chtějí si nadefinovat rigidní rozhraní místo snahy o spolupráci na nejlepším výsledku. Agilita je o společné zodpovědnosti za vše, co s vyvíjeným software souvisí. Včetně požadavků. Odolejme pokušení sortovat na ty, co dělají zadání a na ty, co podle zadání dělají konstrukci. Jsme jeden tým. Pokud můžeme, posaďme zákazníka, analytika, programátora, testera a další lidi do jedné kanceláře. Nebo je propojme nějakým efektivním komunikačním kanálem. Potřebujeme dobrou komunikaci, rychlou zpětnou vazbu a rychlé zapracování změn.

Zrovna dodělávám kompletní specifikaci

Projektový manažer: “Výborně Karle, ta specifikace vypadá neprůstřelně, teď to necháme kluky naestimovat a můžeme podepsat smlouvu.”

Pokusy vytvořit kompletní specifikaci ještě před konstrukcí (up-front) možná fungují u malých věcí nebo u opakujících se podobných projektů. Často ale ani tam. U větších věcí s vysokým stupněm inovace a nejistoty jsou ale podobné ambice tvrdě trestány. Navýšením nákladů a frustrací ze zbytečné práce, kterou musíme často zahodit. Rigidní vodopádová snaha zakonzervovat požadavky je často naivní obranou proti neschopnosti efektivně provádět změny během konstrukce. A nebo je důsledkem striktní smlouvy o dílo, kde zákazník raději vsadí na jistotu “dodání funkcionality v požadovaném rozsahu”.

Buďme připraveni na změnu. Mějme na paměti celek, ale rozdělujme na podproblémy. Specifikujme vysokoúrovňové business požadavky. Analyzujme je podle priority a rozpracujme do podrobnějších produktových požadavků ve formě user stories. Prioritizované user stories nám vytvoří produktový backlog. User story ale zatím není zadání, na které čeká programátor. Je to pouze placeholder pro následnou detailní specifikaci.

Když se na user story dostane řada, začíná její detailnější analýza a definice požadavků. Očekávanými výsledky jsou popis chování systému (use cases), upřesnění UI (mock-ups) a nefunkcionální specifikace. Analytik analyzuje problém a navrhuje řešení v úzké spolupráci se zadavatelem. Využívá znalostí a spolupráce dalších rolí v týmu. V případě rizik, omezené znalosti technologií nebo možnosti více konceptů, je prováděno rychlé prototypování. Ty nejrizikovější věci by měly být odprototypovány na začátku projektu.

Dobrou praktikou je vytvoření test cases ještě před vlastní konstrukcí. V této fázi mohou test cases odhalit závažné nedostatky ve specifikaci požadavků a ušetřit tak spoustu peněz v případě pokračování špatným směrem. Pokud tester není schopen napsat kompletní a jednoznačné testovací případy, zřejmě ani programátor nebude schopen efektivní implementace. Zkušený tester prokoukne nedefinované alternativní větve, chybějící podmínky nebo neošetřené chybové stavy. Často jsou v detailech ukryta závažná projektový rizika.

Nevíte někdo, jak to funguje?

Analytik: “Omlouvám se za hromadný email na všechny lidi ve firmě, ale nemůžu najít specifikaci business pravidel pro XY. Poradí mi někdo, prosím?”

Odpověď A: “Aleši, to by mě taky zajímalo, až to zjistíš, dej mně prosím vědět.”

Odpověď B: “Zkus složku SpecABC, jsou tam nějaké staré wordy. Kdyby to nebylo tam, tak něco možná bude na naší wiki. Jinak dělal to Lojza a ten už ve firmě není. Jak asi víš, z těch přesčasů mu nakonec hráblo. Pokud to nenajdeš, budeš to muset pochopit z kódu. Ale to ti fakt nezávidím. :)”

Na začátku každého projektu vše vypadá krásně a růžově. Lidé jsou nadšení. Všichni zúčastnění vědí o projektu téměř všechno. Nějaká specifikace možná existuje, ale její správě a aktualizaci se často nevěnuje příliš velká pozornost. Požadovaná funkcionalita se dodává rychle, všechno klape a management se poplácává po zádech. Všichni jsou happy.

Projekt roste, vyvíjí se, nová funkcionalita přibývá a stávající se mění, noví lidé přicházejí, původní odcházejí. Je nutná specializace, komplexita systému je už příliš vysoká. Začínají se zvyšovat náklady na správu všech projektových artefaktů. Kde máme aktuální informace? Co všechno se musí upravit kvůli novému požadavku? Jaká jsou rizika? Co vlastně máme před releasem otestovat?

Špatné nakládání se specifikací systému je jednou z nejrizikovějších forem softwarového technického dluhu. Členové týmu zdlouhavě dohledávají informace, dělají špatná rozhodnutí na základě nesprávných informací, vznikají duplicity, zvyšuje se chybovost, management je pod tlakem a přehazuje lidi podle toho, kde to nejvíce hoří. Lidé nemají možnost dělat práci kvalitně a proto frustrovaně odcházejí. Někdy může situaci dospět až k tomu, že údržba projektu je tak drahá, že se už dále nevyplácí a projekt je ukončen. Poslední ať zhasne.

Začněme správu požadavků řešit co nejdříve. Celý proces musí být co nejefektivnější a nejjednodušší. Složité postupy nefungují. Zde je přehled Requirement Management Software. Pokud máte s nějakým systémem větší zkušenost a můžete jej doporučit, přidejte prosím komentář.

Výkonný systém s intuitivním UI

Programátor: Arnošt mi zase poslal zadání, ve kterém píše “vytvořit dostatečně výkonný modul s intuitivním ovládáním, podobný tomu z loňska, ale upravený pro letošní administrativu”. Jdu ho intuitivním způsobem poslat k šípku, podobně jako loni.

Jak psát efektivně požadavky je popsáno v Writing Quality Requirements. Je to už sice hodně vousatý článek, ale přehledně shrnuje to nejdůležitější. Čemu se máme vyvarovat a na co se zaměřit. Jedná se o povinné čtení pro všechny vývojáře software.

Podobně jako jsme zvyklí revidovat kód, abychom našli problémy a sdíleli znalosti o implementaci, můžeme revidovat i požadavky. Analytik musí vysvětlit své chápání problému a důvody proč navrhl toto řešení. Pár tipů na review najdete v How to Conduct a Requirements Review.

Dobrý business analytik je vyladěnou kombinací doménových znalostí a analytických dovedností, viz. např. What Business Analyst Skills are Important. Ty je potřeba neustále procvičovat a vylepšovat. Jak rozvíjíte BA ve vašem týmu?

Shrnutí

Dobře definované požadavky na systém jsou prvním zásadním krokem pro kvalitní výsledek snažení celého týmu. Nesnažme se však všechno vymyslet a popsat hned na začátku. Riziko špatné specifikace je příliš vysoké. Změny pak budou bolet mnohem víc než při postupném iterativním vývoji.

Chápejme proces specifikace systému jako spolupráci celého týmu. Nechtějme programátory-opičky, kteří dostanou přesné zadání a jen klepou. To nefunguje. Chceme myslící bytosti, s určitou znalostí domény, aktivně zapojené do procesu vytváření software.

Specifikace je živá interaktivní dokumentace, která se musí efektivně udržovat po celou dobu života projektu. Úroky za macešský přístup k požadavkům jsou totiž příliš vysoké.

Podělíte se s námi o to, jak se daří spravovat požadavky u Vašeho projektu? Díky.

sobota 23. května 2015

Programátore, chceme tě mít on-site

"Po nějaké době je možné dohodnout částečný home-office"
"Projekt je krátkodobý proto klient vyžaduje on-site"

Ach jo, píše se rok 2015 a většina IT firem u nás stále není mentálně připravena a aktivně nepodporuje remote work. Vidí spásu v tom, že budou mít všechny ovečky pěkně pohromadě v budově, do které investovaly velké peníze. Ztrácejí tak možnost spolupracovat s lidmi, kteří mají odbornost, dostatek sebekontroly a požadovaný výsledek by mohli dodat dříve a ve vyšší kvalitě.

Proč? Většina projektů v IT se zpožďuje, prodražuje se a původní estimace, pracně vytřepané z rukávu a několikrát pozměněné, se nám ve finále smějou do očí. Představa, že budou muset vysvětlovat vyšší náklady na projekt a ještě fakt, že tým pracoval remote, mnoho projekťáků děsí. Nebudeme si proto komplikovat situaci, co říkáte?

"Práce remote není pro každého." Pro koho tedy není? Pro někoho, kdo při on-site na rozdíl od remote odvádí výsledky? Aha, takže pracuje dobře jen pod dohledem nadřízeného. Chcete takového kolegu?

"Jak mám jako vedoucí sledovat progres remote týmu?" A jak jej sleduješ u on-site? Efektivní vývojové metodologie nejsou nijak zásadně závislé na tom, jestli transformátory kávy na kód sedí blízko sebe nebo stovky kilometrů. Mnohem více jsou závislé na dobré komunikaci, dostatečné zpětné vazbě a dobrých návycích členů týmu. Zkuste si remote pair work, je to fajn.

"Když já opravdu nevím, co vlastně doma dělá." Dělá to, co je typické pro tvůj tým a firmu. Pokud máš dobře motivované zaměstnance, jste orientovaní na výsledek a kvalitu, bude to dělat i vzdáleně. Prostě pokud ho práce baví, neměj strach. Pokud umíš řídit lidi, poznáš, že někdo do týmu nepatří.

"Komunikace není efektivní, navíc mě pořád ruší zprávy na messengeru". V dnešní době rychlých připojení k internetu a nástrojů pro spolupráci asi nebude problém ve vzdálenosti. Hledej problém někde jinde - v organizaci času a práce, v efektivitě týmových schůzek, ve schopnosti přepnout do distraction-free režimu.

"Lidé, dokonce i programátoři, potřebují trávit společně čas". Tak určitě. Ale kolik vlastně?

Sedí tam hodně programátorů a všichni mají sluchátka, co je to? Open space.

IT firmo, chceš kvalitní lidi nebo je potřebuješ mít hlavně všechny pohromadě?

sobota 31. května 2014

Malými krůčky ke zvládnutí velkých úkolů

Tento příspěvek je krátkou obhajobou dekompozice složitých problémů na malé koncové tasky. Práce s malými tasky totiž působí přímo blahodárně na často dost zatížené nervové soustavy členů projektového týmu. Pokud se váš projekt zasekává a dostává se do vážnějších problémů, zkuste se zamyslet nad tím, zda-li nebojujete s problémy, které jsou typické pro nezvládnutí správné dekompozice složitosti.

Malý task

Co je vlastně myšleno malým taskem? Pro mě je to task s dobou realizace do 4 hodin, ale ideálně kolem 2h. A nezávisle na tom, zda-li se jedná o práci analytickou, návrhovou, implementační, testování nebo úkoly spojené s podpůrnou infrastrukturou projektu a byrokracií (paper work). Velikost commitu v případě implementačního tasku by neměla překročit řádově desítky změněných řádků (počítáno jako LLOC). Na druhou stranu je počet změněných řádků kódu dost zavádějící metrika. Někdy můžeme půl dne hledat bug a výsledkem je změna na jednom řádku (+ nový původně padající test). Jindy děláme refaktoring a jeden rozsáhlejší rename vynutí změny na stovkách řádků.

Ne vždy se to podaří ...

Rozložení řešeného problému na malé postupné krůčky je efektivní a univerzální technika ve všech oborech lidské činnosti. Ve vývoji software je ale nutné mít vhodné podpůrné nástroje a efektivní postupy. Jinak se dobře míněná snaha o zvýšení efektivity práce změní ve znechucené trápení. Je nutné zajistit splnění několika základních podmínek:

  • Pracovní postupy by neměly být zatíženy přílišným formalismem. Čím méně restriktivních opatření, tím lépe. Příliš formální metodiky jsou účinnou antikoncepcí proti vytváření malých tasků. Předpokládám, že agilita si vybojovala místo i ve vašem vývojovém týmu a proto bude tato podmínka bude splněna.
  • Používejte nástroj, který vám usnadní správu a vizualizaci tasků. Protože jsou malé, je jich také mnoho. Nástroj musí být intuitivní, rychlý a dostupný bez omezení. My jsme se rychle spřátelili s YouTrackem, který pro naše potřeby maximálně vyhovuje.
  • Vytvoření tasku musí být rychlé. Vybrat umístění (projekt, feature nebo user story), zadat název, stručný popis, akceptační kritéria a estimaci. To by mělo ve většině případů stačit. Někdy se při vytváření tasku zasekneme, neboť napsat dobré zadání je pracné. Ale zdržovat by nás mělo pouze naše myšlení a ne použitý nástroj.
  • Používejte pouze atributy, které potřebujete. Šablona tasku, která má desítky atributů je dobrá obvykle jen pro někoho, komu potřeba projektové formalizace způsobila neléčitelnou ztrátu zdravého rozumu. V jednoduchosti je síla, proto nejdůležitější položky musí být dostupné rychle, bez nutnosti překlikávání. Méně využívané položky by pak měly být schované na detailových kartách. A nepoužívané bez milosti odstraněny. Dvakrát si rozmyslete, než přidáte nový atribut.
  • Workflow tasku musí být jednoduché. Čím méně stavů tím lépe. Na našem posledním projektu jsme zvolili tyto: Backlog, Ready for Dev, Dev in Progress, Ready for Review, Review in Progress, Finished (+ Waiting) s vizualizací pomocí Kanban boardu. Pokud bychom neměli interní politiku o revidování každého tasku, pak bychom ještě dva stavy ušetřili. Některé typy tasků ale jedou v jiném režimu, např. task typu Bug nahlášený od testerů nebo v horším případě z produkce.
  • Mělo by být možné integrovat systém pro evidenci tasků s dalšími články vývojové infrastruktury. A to se správou repository, buildovacím serverem, IDE, CASE, apod. Např. k namapování změn v kódu na příslušný task pak pouze stačí odkazovat id tasku v commit message.

Ale když se to podaří ...

A v čem jsou vlastně malé tasky šikovnější než ty velké obludy?

  • Rychlé vyřešení tasku působí blahodárně na psychiku a dobrý pocit z dokončení je účinným motivátorem do další práce. Rozplizlé dlouhé tasky nás naopak demotivují, nevidíme na jejich vzdálený konec a vnášejí pochybnosti o naší pracovní efektivitě. Tak jako většina lidských činností je i vývoj software psychologickou hrou s naším podvědomím, snahou udržet nadšení, pozornost a správný kurz k požadovanému cíli.
  • Menší jednotky práce je snadnější přesně specifikovat. Problém jsme nuceni už při zadávání lépe promyslet a zadefinovat akceptační kritéria. Dobrým zadáním problému zvyšujeme pravděpodobnost správné realizace a efektivního review.
  • Přesnější estimace. Je dost deprimující, když se skutečná pracnost na hony liší od té odhadované. Malé úkoly trefíme mnohem lépe. Doporučuji mírně pesimistický přístup a zohlednit časovou rezervu. Udělat úkol dříve než se čekalo je povzbuzující. Máme ze sebe dobrý pocit a roste nám správným způsobem sebevědomí. Naopak výrazné přešvihnutí estimace nás dostává pod tlak, který často vyústí ve sníženou kvalitu výsledku.
  • Review menších změn je mnohem efektivnější. Je zřejmé, na co se zaměřit. Review trvá kratší dobu, takže reviewer je pozornější, neusíná a často i něco objeví.
  • Stává se méně často, že odcházíme domů a zůstane po nás nedokončený úkol. Já osobně nemám tyhle situace vůbec rád a když něco nedotáhnu do konce, přemýšlím nad tím ještě doma. A nejhorší je nedotahovat věci v pátek odpoledne.
  • Pokud zaneseme chybu nebo rozbijeme CI build, pak je problém mnohem lépe dohledatelný. Je rozdíl, pokud hledáte v commitu s 20 změněnými řádky nebo s 200.
  • Dostáváme rychlejší zpětnou vazbu a pokud se něco nepovede, nevracíme se příliš daleko dozadu. Víme, jak je nepříjemné zahodit kód, nad kterým jsme strávili dlouhé hodiny nebo dny. Obvykle je ale výhodnější špatný kód zahodit, než obhajovat jeho smysluplnost a tím jeho eutanázii pouze oddalovat a zvyšovat tak náklady na vývoj.
  • Malé tasky vnášejí do vývoje větší dynamiku a celý tým může sledovat postup řešení většího celku, třeba user story. Nestává se, že programátor dostane zadání, pár dnů o něm nevíte a pak se objeví s “vymazlenou” implementací, která se ale hodně odklonila od původního záměru a trpí mnoha nedostatky.
  • Jistě znáte techniku TDD, která nabádá ke krátkým implementačním cyklům se strukturou: 1. rozmysli si co chceš (napiš test), 2. naimplementuj to (napiš produkční kód), 3. zkontroluj, jestli změna nerozbila celek (všechny testy zelené), 4. vylepši fungující implementaci (refaktoring). Díky TDD dostáváme okamžitou zpětnou vazbu o stavu našeho kódu. Malý task by pak v tomto chápání mohl mít podobný efekt jako cyklus TDD, ale s větší granularitou. Nutí nás více rozmýšlet požadovaný výsledek, ten dostáváme již během několika hodin. Po uložení změn do repository získáme skrze CI build informaci o stavu celku. V rámci review můžeme řešení ještě vylepšit.

S malými tasky můžeme dosáhnout velkých výsledků. A navíc velmi efektivním způsobem. A za každé dokončení tasku se můžeme nějak odměnit. Třeba procházkou k lednici, krátkou rozcvičkou nebo dobrým kafem. A život programátora bude zase o něco veselejší! ;)

neděle 4. května 2014

Mýty o češtině v softwarových projektech

Pojďme společně rozkrýt několik mýtů pojících se k používání češtiny v softwarových projektech. Do mých názorů se promítají zkušenosti ze dvou zcela odlišných softwarových firem a světů. Dřívější firma byla orientovaná na regionální trh (ČR, SK) a všechny projekty byly realizovány v češtině. Stávající firma naopak dodává systémy do všech koutů světa a na vývoji pracují lidé z více států. Vývoj tedy logicky probíhá kompletně v angličtině.

Je potřeba přiznat, že ještě před několika lety bych určitě mluvil jinak a tento blogpost bych nenapsal. I z některých mých prehistorických příspěvků je zřejmé, jaký pasivní zastánce češtiny v kódu jsem dříve býval. :) Možná ne přímo zastánce, ale spíš ten, kterému čeština nijak výrazně nevadila. Byl jsem tak prostě zvyklý roky programovat a celé to zapadalo do požadavků na software realizovaných projektů. Domnívám se, že není problém své názory měnit na základě poučení z chyb a podle postupně získaných zkušeností. :)

Mýtus "Programátor nepotřebuje umět výborně anglicky"

Znalost angličtiny je jednou z klíčových dovedností programátora. Dalo by se říct, že je to takový meta-skill. Náš obor klade vysoké nároky na průběžné učení a rozšiřování profesní kvalifikace. Bez znalosti angličtiny je právě získávání nových dovedností a znalostí velmi problematické. Knížky, fóra, github, blogy, socsítě, návody, dokumentace, a další jsou studnicí informací, které mohou rozhodovat o úspěchu či neúspěchu celého projektu.

Zdrojový kód je důležitý komunikační prostředek celého týmu. Jazykové schopnosti členů týmu se výrazně projeví na kvalitě celého kódu. Špatné pojmenování je významným zdrojem programových chyb a nečekaných překvapení. Testy slouží jako interní dokumentace systému a jejich názvy musí být co nejvýstižnější.

Určitě nezastávám názor, že programátor, který neumí pořádně anglicky, není schopen vytvářet ve výsledku kvalitní aplikace. Věřím, že mnoho dobrých aplikací napsali a ještě napíšou lidé, kteří anglicky umí velice špatně. Ale mnohem větší procento dobrých programátorů angličtinu ovládá dobře. Je to stejné jako s jinými skilly. Nemusíte psát testy, používat TDD, CI, agilní metodiky, prototypování, iterativní vývoj, revize kódu, apod. a požadovaného výsledku také dosáhnete. Otázkou je v jaké kvalitě a s jakou efektivitou? A hlavně, kdo a jak bude schopen aplikaci dlouhodobě udržovat a rozvíjet?

Souvislost jazykové vybavenosti programátora a otázka pracovních příležitostí na zajímavých projektech je na samostatný blogpost. Určitě má zkušenosti každý, kdo se v poslední době zajímal o nějaké pracovní nabídky. Angličtina je již téměř všude must-have. A kde není, tam je to podezřelé. :)

Mýtus "Čeština ve zdrojovém kódu nevadí"

English. Lingua franca for programming.

Z pohledu někoho, kdo angličtinou příliš nevládne, je čeština jedinou šancí jak významu kódu porozumět. Já ale za ideální situaci považuji, když jediným místem ve zdrojových kódech, kde objevíme češtinu, jsou lokalizované resources. Čeština namíchaná s angličtinou snižuje čitelnost kódu. Do názvosloví se zanášejí patvary typu ObjednavkaFactory, ObjednavkaTovarna, getCena, apod. Neustále se řeší, co se má přeložit a kdy je lepší ponechat anglický ekvivalent. Pamatuji na situaci, kdy kolega pojmenoval třídu 'Kanalovna', protože pracovala s channels WCF služby. Jiným hezkým případem programátorské lidové tvořivosti budiž chybová hláška z přiloženého tweetu, kterou nedávno zpopularizoval Augi. Prostě hromada problémů způsobená díky pokusům sloučit dva nekompatibilní jazykové světy.


Mýtus "Terminologie domény by měla být v češtině, protože v ní máme větší vyjadřovací možnosti"

Nejčastější výjimky z pravidla “vše v angličtině” se dělají na úrovni názvů doménových objektů. Argumentem bývá terminologická složitost některých specifických domén, kdy je problém najít vhodný termín “alespoň v češtině”. Pokud ale najdeme vhodný termín v češtině, určitě ho najdeme také v angličtině. V některých případech se určitě vyplatí spolupracovat se zkušeným překladatelem. Doménu by měli dobře znát doménoví analytici a v potřebném rozsahu také programátoři. Kodéři bez znalostí souvislostí nemají obvykle v projektu příliš vysokou hodnotu.

Osobně vidím problém ještě někde jinde. A sice je nutné, aby každý projekt měl dobře definovaný doménový slovník, ze kterého vychází terminologie používaná v projektu. Z vlastní zkušenosti vím, jak velký problém to bývá. Pokud se už na začátku projektu nezadefinují jednoznačně pojmy, pak to dopadá tak, že se systém hemží synonymy a různými názvy pro stejnou entitu nebo vlastnost. Takové nejednoznačnosti výrazně komplikují pochopení a udržovatelnost systému.

Mýtus "Každý softwarový projekt by měl být realizován v angličtině"

Jsou projekty, u kterých je jasné, že jiná možnost než angličtina neexistuje. Např. děláte pro zahraničního zákazníka, ve vašem týmu se mluví více jazyky, máte globálnější ambice, vyvíjíte nějaký open-source nebo prostě jen chcete, aby váš kód pochopil i někdo nemluvící česky. Na druhou stranu jsou stále situace, kdy je nutné projekt realizovat ve větší míře v češtině. V případě, že máte pouze lokálního zákazníka, kterému nevadí, že nebude mít projektové artefakty v angličtině a současně nemáte tým, který by to v angličtině zvládl. Pak to zřejmě smysl má. Osobně si ale myslím, že takové ryze české projekty budou stále více v menšině. Uvědomělí zákazníci budou požadovat za svoje (nemalé) investice realizace projektů, které nebudou pevně svázané s lokálním jazykem.

Mýtus "Dobrá kombinace je kód v angličtině a zbytek v češtině"

Nevidím to jako úplně dobrý nápad. Takový hybrid asi nebude použitelný pro někoho, kdo nemluví česky. Při realizaci projektu se navíc budete muset neustále přepínat mezi češtinou a angličtinou. Rozhodněte se pro angličtinu a vytvářejte všechny projektové artefakty v angličtině. Zpočátku to možná bude trochu drhnout, ale vydržte, výhody jsou zřejmé.

Mýtus "Kód v angličtině, komentáře v češtině"

Raději dobře čitelný kód, který nepotřebuje (nedokumentační) komentáře. A pokud jsou přeci jen potřeba, pak bych rozhodně zůstal u angličtiny. Komentáře v češtině by se nejspíše staly nesmyslnými ostrůvky vítězství programátorova nacionálního cítění. U dokumentačních komentářů předpokládám, že budou vždy v angličtině.

A na závěr jeden bonbónek ...

"Pro větší názornost jsem zdrojový kód přeložil do češtiny"

Néé, jen to ne. Pokud k tomu autor překladu odborné literatury přidá ještě jako bonus diakritiku, pak takovou knížku dočte do konce zřejmě jen hodně otrlý jedinec. ;)

Jaký názor na symbiózu češtiny a angličtiny máte vy? Díky za komentář.

sobota 26. dubna 2014

Dopřejte vašemu kódu pořádnou revizi

Revize kódu (code review) patří mezi techniky, které mohou posunout vnitřní a vnější kvalitu vašeho systému do vyšší ligy. Musí se však dělat správně a efektivně. Revidování kódu může být časově náročné a od manažerů víme, že čas jsou peníze. Proto se systematické revidování používá především u projektů, kde je kvalita nadřazená brzkému dodání. Na druhou stranu, pokud jste někdy dělali na projektu, který se dostal do spirály smrti díky tragické kvalitě, jistě se shodneme na tom, že pojem “rychlý vývoj” je vždy relativní. Dobré revize v konečném důsledku čas a náklady na projekt snižují.

Revidovat kód lze mnoha způsoby. Ti co programují v páru, provádějí revizi kódu nepřetržitě již během jeho psaní. V ostatních případech jsou fáze psaní kódu a fáze revidování v čase odděleny. Čím více je revize opožděna za implementací, tím jsou ale případné nápravy komplikovanější. Revize se také liší stupněm formálnosti, rozsahem (např. pouze kritické části aplikace nebo všechno), počtem revidujících (jeden nebo celá skupina) a tím, zda-li je autor kódu přítomen nebo ne.

Hlavní přínosy

K čemu konkrétně jsou vlastně revize kódu dobré? Pomáhají nám v především v těchto záležitostech:

  • Ověřování splnění zadání.
  • Objevování chyb a případných rizik.
  • Zlepšování kvality návrhu.
  • Zlepšování čitelnosti kódu.
  • Zlepšování udržovatelnosti kódu.
  • Šíření znalostí a způsobu řešení problémů.
  • Zvyšování zastupitelnosti členů týmu.
  • Autor kódu dostává zpětnou vazbu ke svojí práci a díky ní se rychleji zlepšuje.

Dobře revidovat kód je dovednost, kterou musíme neustále procvičovat a zlepšovat. Abychom zbytečně nemrhali časem, ale aby nám revize opravdu sloužily, musíme si pohlídat několik základních věcí. Sem s nimi ...

Co mám vlastně revidovat?

Co opravdu, ale opravdu nemáme jako programátoři rádi, jsou špatně zadané úkoly. Při implementaci už není prostor na neurčitost. Ta nás brzdí a blokuje. Psát jednoznačné a srozumitelné zadání je ctností dobrého analytika. “Chytře” zadaný úkol (mrkněte na SMART) zvyšuje pravděpodobnost správného pochopení a odpovídající implementace a efektivní revize. Těžko ověříme splnění zadání, pokud je odbyté nebo nejasné. I jako revidující si vyžádejme upřesnění zadání, pokud je to potřeba. Revizí přebíráme stejnou zodpovědnost za úkol jako ten, kdo jej naimplementoval.

Velký nebo malý úkol

Revize malé změny - hodně připomínek, revize rozsáhlé změny - vypadá to dobře.

Pokud chceme mít revize opravdu smysluplné, dekomponujme problémy na pokud možno co nejmenší úkoly a ty revidujme odděleně. Implementace úkolu by neměla trvat více než jen několik hodin. Příliš rozsáhlé změny ukryjí defekty kódu, špatný design, bugy a jiné nedostatky. Snaha pochopit cizí kód (někdy i svůj) je vysoce náročná na soustředění a to jak víme není zadarmo. Po krátké době jsme unavení tak, že přepínáme na autopilota a pravděpodobnost přehlédnutí problému letí nahoru.

Dohledatelný rozsah změny

Rozsah revidované změny musí být jasně dohledatelný. Proto je vhodné, aby každý commit do repository byl logicky mapovaný právě na jeden úkol. Buildovací servery pak z takových commitů umí vyrobit ke každému úkolu přehledné reporty se zvýrazněním změn v jednotlivých souborech. Bez kvalitních podpůrných nástrojů a jejich vzájemné integrace se revize snadno změní ve zmatené prohlížení potenciálně změněných souborů.

Dobrá kondice revizora

Když se pořádně vyspíme, není pátek odpoledne a nemáme kofeinový deficit, pak máme nakročeno ke kvalitní revizi. Všechno je najednou mnohem jasnější. Prostě nemá smysl revidovat, když je člověk unavený. Je to podobné jako s programováním, jenom s tím rozdílem, že sice žádnou chybu nepřiděláme, ale ani žádnou neobjevíme.

Potřebná úroveň znalostí

Schopnosti a dovednosti revidujícího by neměly být výrazně nižší než schopnosti autora kódu. Mohlo by se pak totiž stát, že se mu zvolené řešení i kód bez výhrad líbí, přestože ve skutečnosti trpí mnoha nedostatky. A taková revize nemá žádný význam. Revidovat by proto měli ti zkušenější z týmu. Revidující by měl mít dobré znalosti použitých programovacích jazyků, frameworků, návrhových vzorů a principů, a mnoha dalších věcí. Jedním z přínosů revizí je právě to, že méně zkušení členové týmu získávají skrze zpětnou vazbu z revizí mnohem rychleji nové zkušenosti a tím se profesně zlepšují.

Automatizujme

Používejme nástroje pro statickou a dynamickou analýzu kódu, které se budou automatizovaně spouštět v rámci buildů hlídajících kvalitu. Co lze zkontrolovat automatizovaně to nemusíme revidovat. Šetřeme čas a soustřeďme se na záležitosti, které za nás programy nevyřeší.

Optimalizujme workflow

Pokud zatím revize nepoužíváte, zavádějte je opatrně. Hledejte ideální workflow, které bude kompatibilní s vašimi vývojovými procesy. Vyzkoušejte více variant a vyberte tu pravou. Až se vám revize dostanou pod kůži v rámci menšího týmu, teprve potom je zavádějte ve větším rozsahu. Revize kódu mají své opodstatnění jak v agilních, tak i především ve formálnějších metodikách. A není problém kombinovat revize více typů. Například my v rámci našeho projektu děláme některé úkoly v páru (okamžitá revize). Většinu úkolů ale revidujeme ad-post bez autora nebo při komplikovanějších věcech i s jeho přítomností. Velké implementační celky ještě revidujeme více formální revizí se softwarovým architektem zákazníka.

Sociální aspekty revize

S revizí kódu je to jako se ženou - ani nevíte jak a už jste v problémech. Je potřeba k ní přistupovat opatrně, lehce našlapovat a ve vyjadřování volit slovník gentlemana. Výstupem revizí by měly být připomínky, které zlepší kvalitu kódu a nezhorší vztahy v týmu. Případná kritika by měla být věcná, slušná a cílená na konkrétní problém. Žádné osobní útoky. Svojí nešikovností nebo dokonce špatným úmyslem, můžeme rozpoutat nepříjemné konflikty, které se projeví na fungování týmu. Velkým problémem je také nadřazený přístup zkušenějších vývojářů k těm méně zkušeným. Zdravě fungující tým by si měl s podobnými problémy poradit, ale i přesto buďte opatrní.

Motivace odvádět kvalitní práci

Dobře motivovaný tým chápe revize jako další prostředek ke zlepšení výsledků svojí práce. Na týmy s problematickou úrovní práce může mít zavedení revizí také velmi příznivý efekt. Programátoři, kteří kvalitu kódu do té doby příliš neřešili a v tichosti si něco bastlili, mají najednou nové starosti. Jejich kód začne někdo jiný číst a dokonce připomínkovat. Někdy i veřejně v rámci celého týmu. Dotyčný by musel být skutečný rebel, aby to v něm nehrklo a nezačal více přemýšlet nad tím co a jak píše. Najednou bude jeho práce srovnávána s kolegy a nikdo nechce patřit mezi ty, kteří jsou hodnoceni špatně. Opět pozor na sociální stránku zavádění revizí. Ať se vám v týmu nezačne příliš jiskřit.

Jak vám to reviduje?

Moje osobní zkušenosti s revizemi kódu jsou téměř výhradně pozitivní. Postupně jsme si vyladili vývojový proces tak, že díky revizím kódu těžíme z výše popsaných přínosů. Hodně jsme se vzájemně naučili. Jakmile někdo objeví nový trik, hned ho umí i revidující. Dost nám pomáhají revize se softwarovými architekty z Německa, kteří mají dlouholeté zkušenosti s vývojem jejich systému, do kterého aktuálně píšeme moduly. Jejich rady nás mnohokrát nasměrovaly k lepšímu řešení.

Za mě tedy revizím kódu jednoznačné ANO.

A jaké máte zkušenosti s revidováním kódu vy? Dobré nebo špatné?

neděle 19. ledna 2014

Agilita v korporátním světě

… aneb honba za nulovou chybovostí

Aktuálně dělám na projektu, který je zajímavý z několika pohledů. Jedná se o software pro medical devices, kde jsou kladeny vysoké nároky na zajištění kvality. A neméně zajímavou skutečností je střet historicky vodopádového korporátního přístupu se sílícím vlivem agilních technik. Rád bych popsal zajímavé oblasti naší práce s důrazem na postupy, které nám pomáhají zajišťovat požadovanou kvalitu.

Co vlastně děláme

Na úvod stručně ke kontextu naší práce. Máme v Olomouci tříčlenný vývojový tým a pracujeme pro německou zdravotnickou korporaci Maquet. Konkrétně spolupracujeme se softwarovým oddělením na vývoji systému Tegris. Ten integruje ovládání různých zařízení používaných na operačním sále do jedné aplikace. Ovládat se dají například chytré operační stoly, speciální světla, HD kamery, endoskop a další. Systém má mnoho pokročilých funkcí pro nahrávání a streamování multisource videa. Zajišťuje také různé agendy potřebné při operacích. Jedná se o softwarové řešení dodávané spolu se speciálním hardware, kvůli vysokým nárokům na systém a požadavkům na mnoho speciálních karet a portů. Prostě být operován na sále s tak moderním vybavením musí být snem každého pacienta. Nebo raději ne. ;)

Prvním naším projektem byla integrace ovládání videokonferenčních systémů. Zjednodušeně řečeno jsme vyvíjeli modul, který umožňuje při operaci provádět videokonferenční hovory a ovládat je z Tegrisu.

Aktuálním druhým projektem je ovládání zařízení, která jsou připojená k nové hardwarové sběrnici. Na tu lze nyní připojit chytré světelné hlavy a HD kamery používané na operačním sále. Každé zařízení má své vlastní hardwarové ovládací panely. Nově tato zařízení půjdou ovládat také přes systém Tegris. A to je naším úkolem.

Vývoj pro medical devices

Vývoj software pro medical devices má svá specifika. Pokud chcete software dodávat do států EU, pak musíte být kompatibilní s hromadou direktiv sjednocených pod MDD. Jedná se o tak složitou byrokracii, že je jen pár lidí na světě, kteří ji mají kompletně nastudovanou a nechají si zaplatit slušný peníz za základní proškolení. Když chcete prodávat do USA, pak musíte být zase kompatibilní s direktivami vydávanými americkou FDA. Ve výsledku to vypadá tak, že potřebujete ve firmě alespoň jednoho člověka na plný pracovní úvazek, který zkoumá, co musí jednotlivé softwarové komponenty splňovat a jaké nároky jsou kladeny na samotný vývojový proces. Takovému člověku opravdu nezávidím. ;)

Pro nás to znamená, že veškeré vývojové fáze musí být standardizované. Všechny meziprodukty vývojového procesu (požadavky, návrh, kód, testovací případy, …) musí být revidovány někým nezúčastněným. Američané vyžadují navíc diskutabilní 100% pokrytí testy. Velký důraz je kladen na fázi akceptačního testování, testuje se v různých podmínkách (laboratorní, reálné) a před každým release. Veškerá snaha je cílena na dosažení co nejmenší chybovosti v produkci.

Medical devices jsou navíc klasifikovány do několika tříd podle závažnosti následků v případě poruchy takového zařízení. Třeba class I jsou zařízení, jejichž výpadek neohrožuje zdraví pacienta. Class III jsou naopak zařízení, jejichž špatná funkčnost může vést k těžkým následkům nebo smrti pacienta. Např. bylo by hodně nepříjemné, kdyby vynechával kardiostimulátor se speciálním software nebo kdyby se zasekl endoskop pro mozkové operace. Náš projekt řeší světla na operačním sále, ty jsou class II. Kdyby světla zhasla nechtěným zásahem obsluhy nebo z důvodu chyby software, asi by na operačním sále nebylo příliš veselo.

Zadání a estimace projektu

Součástí zadání je více jak stovka různě pracných funkcionálních a systémových požadavků na vyvíjený modul, podrobný popis komunikačního protokolu pro hardwarovou sběrnici a vizualizace UI. Z centrály jsme si dovezli reálné železo, které nám zabírá jednu stěnu naší malé kanceláře.

Bylo potřeba se seznámit s problémem, udělat si jednoduchý prototyp pro komunikaci se zařízeními a rychle dodat orientační estimaci, aby byl hlavní projekťák spokojený. Využili jsme agilní techniku odhadování v abstraktních story points. Poměřovali jsme nejdříve jednotlivé requirementy relativně podle předpokládané pracnosti a oceňovali je s využitím čísel od pana Fibonacciho - 1, 2, 3, 5, 8, 13, 21. Nakonec byl každý bod vynásoben bulharskou konstantou, která měla promítnout abstrakci do reálnějších člověkodnů.

Specifikace architektury

Jeden ze systémových požadavků si vynutil, aby většina business logiky ovládání (nízkoúrovňová komunikace, řízení přístupu, zjišťování stavu zařízení, synchronizace, apod.) byla oddělena od hlavního systému do samostatné aplikace. Tato aplikace musela být zpřístupněna jako služba, kterou mělo mít možnost využívat více klientů. Požadavek zásadně ovlivňoval architekturu řešení. Nakonec bylo potřeba navrhnout několik konceptů, ze kterých byl vybrán ten nejvhodnější.

Vítězný koncept se musel rozpracovat do několika různě abstraktních UML diagramů. Hlavní struktura systému je zachycena pomocí komponentového diagramu. Jednotlivé komponenty pak mají své poddiagramy stále ještě na úrovni poměrně abstraktních podkomponent. Specifikace musela obsahovat popis dalších technických aspektů zvoleného řešení.

Z pohledu agilních technik je použití UML vhodné pro lepší vzájemné porozumění při diskuzi o problému. Zároveň se ale nedoporučuje trávit kreslením diagramů příliš času. Důležitá zpětná vazba přichází totiž až ze samotné implementace. Čím je feedback pozdější, tím jsou případné změny dražší. S ohledem na typ našeho projektu jsme ale při realizaci nuceni používat UML poměrně často.

Rozdělení do etap

Rozplánovali jsme celý projekt na menší etapy, které vzdáleně připomínají agilní iterace. Liší se však zásadně tím, že nemají pevný časový rámec. Vybrané requirementy se musí vyřešit všechny. To je opět úlitba centrálnímu projektovému managementu. Nevýhodou je, že se celá etapa natahuje, nejde vrátit nevyřešené úkoly do backlogu a práce tolik neodsýpají. Paralelní práce na více etapách současně nám navíc moc nefungovaly. I tak ale považujeme rozdělení do etap za lepší přístup než čistě vodopádový model. Zpětnou vazbu o postupu prací dostáváme poměrně rychle a případné “vracečky” nejsou tak bolestivé. Etapa v ideálním případě trvá tak 15 pracovních dnů a prochází všemi níže popsanými fázemi.

Analýza požadavků

Rozdělení požadavků do etap bylo provedeno na začátku projektu. Přesun požadavků mezi etapami není příliš oblíbená činnost u centrálního managementu. Někdy ale není zbytí. Stává se poměrně často, že požadavek je potřeba upřesnit nebo zcela změnit. Pak je dobré, abychom měli “zákazníka” komunikačně co nejblíže. “Změnová řízení” jsou někdy otázkou hodin, jindy zase dnů. Někdy se musí chování upřesňovat s výrobním oddělením ve Francii.

Abychom si mohli naše domněnky rychle potvrdit nebo vyvrátit, pomáháme si prototypováním. Věříme, že s dostatkem informací o problému můžeme udělat lepší návrh. Navíc jsme záměrně naplánovali nejrizikovější požadavky do prvních etap realizace, kdy bylo prototypování nejvíc.

Návrh

Každá etapa má návrhovou fázi, kdy mapujeme řešené požadavky na use cases. Iterativním způsobem rozšiřujeme stávající design. Přidáváme (sub)komponenty a jejich vzájemné vztahy. Rozkreslujeme chování komponent do sekvenčních diagramů. Pokud je potřeba, pomůžeme si stavovým nebo aktivitním diagramem. Snažíme se držet na co nejvyšší nutné úrovni abstrakce. Až na úroveň diagramu tříd chodíme jen zřídka. Designové tasky většinou děláme ve dvojici. Je to pro nás efektivnější metoda, kdy nápady okamžitě diskutujeme, připomínkujeme a případně zahazujeme.

Vytvořený návrh musí projít přes design review, které se provádí za přítomnosti softwarového architekta z Německa. Někdy přímo v Německu a v poslední době se nám také daří dělat review i vzdáleně. Dostáváme zpětnou vazbu a rady od kolegů, kteří mají s podobnými systémy mnohem více zkušeností než my. Někdy sice s jejich argumenty úplně nesouhlasíme, ale to je v software development asi normální. Mnohdy je to bazírování na zdánlivých maličkostech, ale je v tom cítit německá preciznost, která se mi ve výsledku hodně líbí.

Implementace

Pokud se dostaneme přes design review, pak se celí natěšení vrháme do vlastní implementace. Snažíme se o TDD přístup, kterým zajišťujeme fázi návrhu na té nejnižší úrovni. Využíváme také Behavior-Driven Development techniku, která zahrnuje outside-in přístup, zlepšuje dokumentační aspekty testů a elegantně řeší problém jednoho assertu na test.

Jednotkové testy musí testovat třídy v izolaci. Používáme proto různé adaptéry abstrahující třídy frameworku, např. ISerialPortAdapter, ITcpClientAdapter, ITimerAdapter, ITaskAdapter. Asynchronní zpracování musí být v jednotkových testech převedeno na synchronní.

Hodně našich tříd musí být thread-safe. Snažíme se proto psát integrační testy, které testují třídy při paralelním přístupu z více vláken. Zatím nemáme příliš zkušeností se zátěžovým testováním, ale snažíme se to změnit.

Tegris je poměrně rozsáhlý systém, který má vysoké výkonnostní požadavky a jsou nutné značné optimalizace na straně implementace (vlákna, pooling, lazy). Error handling je samostatná kapitola, která nám zabrala jednu celou etapu. Systém se musí umět vzpamatovat sám z některých chybových stavů. A především chyba v jednom modulu nesmí ohrozit činnost systému jako celku.

Co se týče UI, tak děláme pouze dummy verzi, která je později nahrazena verzí finální dodávanou od designérské firmy. Systém je přizpůsoben pro dotykové ovládání. Myši nejsou na operačních sálech vítanou havětí. ;)

Code review

Code review si děláme nejdříve interně sami. Snažíme se, aby se vlastní implementace rozpadala na malé úkoly, které zaberou maximálně několik hodin práce. Takto granulované úkoly se ještě rozumně revidují. Ve větších úkolech se už revidující dost ztrácí. Review nám přináší velkou přidanou hodnotu. Občas odhalíme problém v implementaci nebo problematický design, připomínkujeme (ne)čistý kód, vysokou komplexitu, nešikovnou terminologii, apod. Velkou výhodou je to, že se v našem týmu udržuje povědomí o změnách, učíme se jeden od druhého dobré postupy a zvyšujeme vzájemnou zastupitelnost. Refaktoring není u nás sprostým slovem. Praktikujeme společné vlastnictví kódu. Bohužel se nám nedaří ve větší míře dělat pair-programming. Ale není všem dnům konec.

V závěru etapy je kód revidován kolegy z Neměcka. Dozvíme se zajímavé připomínky a dostaneme zpětnou vazbu od někoho, kdo se přímo na implementaci nepodílel. Za sebe opět hodnotím tento postup velice kladně.

Pokud dojde v rámci implementace ke změnám v designu, zanášíme je průběžně do UML modelu.

Testovací případy

Testovací případy (test cases) jsme si nejdříve psali sami, ale teď to rádi přenecháváme specialistům od našich západních sousedů. Každý požadavek musí být mapovaný na nějaký testovací případ. Testovací případy jsou zjednodušeně řečeno soupisy prerequisities, test steps a expected results. Měl by je psát někdo z QA oddělení a jsou prováděny ručně před každým vydáním aplikace. My si je musíme také projít před akceptací každé etapy.

Znám i zajímavější práci než psát testovací případy, ale na druhou stranu je to užitečný pohled na systém očima uživatele.

Zajímavostí je, že jsme v rámci projektu museli vyvinout poměrně komplexní simulační nástroj. Jedná se o chytrý fake, který se chová jako reálná zařízení. Umí simulovat chybové stavy, odebírat a přidávat zařízení za běhu a další situace, které by bylo drahé a někdy i velmi problematické navodit se skutečným zařízením. Tento simulační nástroj je určen na primární otestování testovacích případů před vlastním testováním v reálných podmínkách. Ani pro testery totiž není vždy možné se rychle dostat k drahému fyzickému zařízení.

Infrastruktura

Centrální projektový management používá pro podporu vývojového procesu systém Polarion, kterému se naše jednotka snaží spíše vyhýbat. ;) Náš tým si většinu času vystačí s nástrojem YouTrack, ve kterém uděláme rozpad celé etapy do malých tasků. Používáme něco na způsob Kanbanu se stavy Backlog, Ready to Dev, Dev in Progress, Ready for Review, Review in Progress, Finished. Každý task musí mít jasně daná akceptační kritéria. Žádné nekonkrétní, problematicky revidovatelné formulace.

Pro kreslení UML byl vybrán Enterprise Architect, který se nám podařilo postupně ochočit tak, aby pracoval pro nás a ne proti nám. Některé jeho features jsou ale opravdu pouze pro otrlé jedince.

Správu zdrojových kódů řešíme přes Mercurial, nad kterým kmitá TeamCity. Buildovací skripty jsou napsané v Rake (Ruby Make).

Pracujeme ve Visual Studio 2012 s ReSharper 7. Aplikace je napsaná v C# nad .Net 4.0, UI je ve WPF a služba je typu WCF. Jako testovací framework je využit NUnit a pro mockování RhinoMocks. Pokrytí testy měříme přes dotCover. Kódovací standardy nám hlídá policajt StyleCop a jiný policajt FxCop zase provádí statickou analýzu kódu.

Pár slov na závěr

Ještě nevíme, jak celý projekt dopadne. Netušíme, jaká bude výsledná chybovost v produkci. Doufáme však, že minimální. Děláme pro to maximum. Snažíme se využívat všech nám známých technik pro zajištění kvality. Získáváme tím už od začátku větší pocit jistoty a práce není stresující. Navíc je docela fajn pracovat pro firmu, která má v Programming Guidelines jako první uvedeno pravidlo:

“It is more important to write correct and maintainable code than supposedly quickly programmed code.”

Můžete se mrknout na komerční videa představující systém Tegris a novou generaci světel Volista.