Dokumentácia webu: prečo ju potrebujete

Čo má dokumentácia obsahovať

• Prehľad: na čom web beží, aký systém, framework a verzie.
• Prístupy: zoznam služieb a kde sú prístupy uložené, nie samotné heslá v dokumente.
• Infraštruktúra: hosting, doména, DNS, e-maily, CDN.
• Napojenia: platobná brána, dopravcovia, účtovníctvo, CRM, automatizácie a ich kľúče.
• Nasadzovanie: ako sa zmeny dostávajú na ostrý web a ako sa vracajú.
• Zálohy: kde sú, ako často sa robia a ako sa web obnovuje.
• Úpravy: neštandardné úpravy kódu a dôvody, prečo vznikli.
• Postupy pri probléme: čo robiť pri výpadku a koho kontaktovať.

Prečo na nej záleží

• nový programátor sa zorientuje za hodiny, nie týždne,
• pri výpadku sa nestráca čas hľadaním, kde čo je,
• neštandardné úpravy sa pri aktualizácii omylom neprepíšu,
• vy viete, čo vlastníte a za čo platíte.

Dokumentácia nemusí byť dlhá

Stačí prehľadný dokument alebo niekoľko stránok, ktoré sa aktualizujú pri každej väčšej zmene. Dôležitejšie ako rozsah je, aby bola aktuálna a uložená tam, kde ju nájdete aj bez programátora.

Kde dokumentáciu uchovávať

Technickú časť priamo pri kóde v repozitári, prehľad pre majiteľa vo firemnom úložisku. Heslá patria do správcu hesiel, nie do dokumentu.

Keď dokumentácia chýba

Pri preberaní webu ju vytvárame ako jeden z prvých krokov, viac v článku Prevzatie webu po inom programátorovi. Pri našej práci dokumentáciu priebežne aktualizujeme, aby ste ju mali k dispozícii kedykoľvek.

Autor: Jakub Porubčan, Xirex