B3du je nástroj pro sdílení a verzování souborů, který se v mnoha týmech používá jako úložiště projektové dokumentace. Jenže samo založení složky a nahrání souborů nestačí. Řada projektů na B3du skončí v chaosu, protože lidé podcení nastavení přístupů, strukturu adresářů a pravidla pro pojmenování. Následující řádky popisují chyby, které se opakují nejčastěji, a hlavně to, jak se jim vyhnout ještě před tím, než vzniknou.
Prvním krokem je zjistit, které z devíti operací databáze skutečně zvládá a v jaké kvalitě. Nestačí se podívat do dokumentace. Napište testovací dotazy, které simulují reálnou zátěž: spojení tří tabulek s filtrem, stránkování přes deset tisíc řádků, agregaci s podmínkou a transakci, která se v půlce přeruší. Měřte nejen výsledek, ale i plán vykonávání a dobu odezvy. Často se ukáže, že databáze operaci „podporuje”, ale bez indexu ji provádí sekvenčním čtením, což je při růstu dat nepoužitelné.
Přístupy a oprávnění řešte dřív, než začnete nahrávat Druhá chyba se týká oprávnění. Často se stane, že do projektu dostane přístup celý tým včetně lidí, kteří do něj nepatří. Stačí jedno nesprávné nastavení a citlivé soubory vidí někdo, kdo by neměl. Před spuštěním projektu si proto napište, kdo má mít jakou roli – kdo jen čte, kdo přidává a kdo spravuje. U každé složky pak nastavte práva zvlášť, ne plošně pro celý projekt. Pokud to nejde, použijte sdílený odkaz s omezenou platností a jasně určete, komu patří.
Dokumentace REST API není dílo pro frontend, které vznikne na konci projektu. Je to průběžná součást návrhu backendu. Pokud ji začnete psát ve chvíli, kdy je hotový poslední endpoint, už nikdy nebude odpovídat realitě a frontend stejně skončí u čtení zdrojového kódu. Začněte popisovat rozhraní v momentě, kdy se domluvíte na prvním kontraktu.
Typické chyby vznikají v detailech. Datum bez uvedení časového pásma a formátu, čísla jako řetězce, prázdné pole místo chybějící hodnoty, rozdílné názvy polí mezi seznamem a detailem. Frontend pak řeší obchvaty a backend se diví, proč se data zobrazují špatně. Sepište si proto jednotný slovník názvů a typů a držte se ho napříč celým API. Když se něco změní, změňte i dokumentaci a oznamte to.
Čtvrtá chyba je ignorování verzí. B3du umožňuje nahrát novou verzi souboru, ale mnoho lidí místo toho vytvoří kopii s jiným názvem. Výsledkem je zmatek v tom, co je platné. Naučte tým používat nahrání nové verze na stejné místo a staré verze nemazat, dokud není projekt uzavřený. Do popisu změn stručně napište, co se upravilo. Pokud se něco pokazí, je pak snadné se vrátit k funkční verzi.
Nakonec nastavte proces. Každá změna kontraktu projde stejnou cestou jako změna kódu — návrh, kontrola, zapsání. Komunikace mezi týmy nemusí být formální, ale musí být včasná. Pokud backend přidá povinný parametr bez upozornění, frontend to odskáče v produkci. Dokumentace, která se aktualizuje společně s kódem, ušetří víc času než jakékoli vysvětlování na poradě.
Třetí problém je pojmenování souborů. Názvy jako „final”, „final2″ nebo „oprava” nic neříkají a za měsíc je nepoužitelné i pro autora. Zaveďte jednotný formát, například datum, zkratku projektu a číslo verze. Vyhněte se mezerám a diakritice v názvech, pokud soubory putují mezi různými systémy. Stejná pravidla platí pro složky. Když se všichni drží stejného vzoru, vyhledávání a třídění přestane být noční můrou.
Na závěr: ruční testování a automatizace se doplňují. Ruční odhalí neočekávané, automatizace hlídá, že se známé chyby nevrátí. Začněte ručním průzkumem na reálných zařízeních, teprve potom pokryjte stabilní scénáře skripty. Pokud budete postupovat opačně, budete automatizovat chyby, které jste ještě nepochopili.
Pátá chyba se týká záloh a přenosu. Projekt na B3du není jediné místo, kde mají data existovat. Pravidelně stahujte klíčové soubory do jiného úložiště a mějte přehled o tom, kdo co vlastní. Při předávání projektu novému člověku nestačí poslat odkaz. Předejte i vysvětlení struktury, seznam přístupů a informaci o tom, které soubory jsou jen pracovní. Bez toho se nový správce v projektu utopí a začne dělat stejné chyby znovu.
Příklady místo odstavců obecných frází Nejužitečnější částí dokumentace jsou konkrétní příklady volání a odpovědí. U každého endpointu uveďte alespoň jeden reálný požadavek s ukázkovými daty a jednu úspěšnou odpověď. Pokud vracíte chybu, přidejte i její podobu — frontend potřebuje vědět, jestli má zobrazit hlášku, přesměrovat, nebo zkusit znovu. Vyhněte se popisům typu „vrátí se objekt uživatele”; vypište pole, jejich typy a to, která jsou nepovinná.
For more about Gpsites.Win have a look at our own internet site.
