Dokumentacja techniczna – jak ją przygotować?

Dokumentacja techniczna – cele
Dokumentacja techniczna – z czego powinna się składać?
Dokumentacja techniczna – jak ją stworzyć?
Wykorzystanie AI w tworzeniu i aktualizacji dokumentacji technicznej
Podsumowanie

Dokumentacja techniczna – cele

Dokumentacja techniczna w organizacji pełni dwa zasadnicze cele. Pierwszym z nich jest cel techniczny, skierowany do zespołów IT wspierających wdrożenia narzędzia analitycznego. Obejmuje on zapewnienie prawidłowego wdrożenia śledzenia, które spełnia wymagania biznesowe firmy i jest zgodne z technicznymi standardami, co oznacza, że wszystko działa poprawnie. 

Drugi, bardziej biznesowy cel, to instrukcja dotycząca praktycznego wykorzystania tych danych w działalności organizacji. Chodzi o to, jak osoby związane z biznesem powinny wykorzystywać dane, a nie o samą obsługę narzędzia, jakim jest Google Analytics 4. Ważniejsza jest zawartość tych danych i to, co można z nich wyczytać, a nie szczegółowa instrukcja obsługi narzędzia. 

Można to porównać do przepisu na potrawę. Dokumentacja techniczna nie jest jak instrukcja obsługi Thermomixa, gdzie krok po kroku wyjaśnione jest, co i jak nacisnąć. Bardziej istotne są składniki przepisu. Nawet jeśli używamy innego urządzenia niż Thermomix, wiedza o tym, jakie składniki są potrzebne do potrawy, pozwoli przygotować ją przy użyciu innego sprzętu. 

Dokumentacja techniczna – z czego powinna się składać?

Elementy składowe dokumentacji technicznej w naszej praktyce składają się z kilku kluczowych części. Pierwszą z nich są pytania biznesowe. Obejmują one wyzwania, problemy i ograniczenia, z którymi organizacja się mierzy w kontekście swoich danych. Są to pytania, na które biznes chciałby móc odpowiadać za pomocą danych, aby lepiej wykonywać swoje zadania.

Drugim elementem są KPI, które mogą być już opracowane przez organizację lub w trakcie ich ustalania można uczestniczyć. KPI to metryki, na których opiera się działalność biznesowa. Jeżeli te metryki wykazują pozytywne tendencje, oznacza to, że biznes się rozwija i rośnie. 

Dokumentacja analityki internetowej powinna zawierać konkretne definicje KPI, aby w razie niezgodności można było odwołać się do pierwszego źródła prawdy. Jeśli pojawią się różne interpretacje, co do sposobu liczenia danej metryki, dobrze jest, aby dokumentacja była klarownym odniesieniem, które to wyjaśni. W przypadku niestandardowych obliczeń specyficznych dla danej organizacji, warto, aby dokumentacja techniczna zawierała odniesienia do sekcji, które dokładnie tłumaczą, jak dana metryka jest generowana.

Istotnym elementem dokumentacji są definicje źródeł danych. Dane online obejmują bowiem nie tylko Google Analytics 4. Dokumentacja techniczna powinna jasno określać źródła danych, szczególnie w kontekście zachowań użytkownika w produkcie cyfrowym. Ważne jest, aby określić, jakie akcje użytkownika prowadzą do zapisania zdarzeń w narzędziu, w tym przypadku szczególnie w Google Analytics 4. Należy opisać, co użytkownik robi, aby wywołać dane zdarzenie i jakie są jego parametry.

W Google Analytics 4 podstawowym parametrem jest nazwa zdarzenia, a dodatkowe parametry opisują konkretną akcję użytkownika. Na przykład, akcja powiększenia zdjęcia może mieć dodatkowe parametry, takie jak źródło powiększenia (czy zdjęcie zostało powiększone z galerii, czy z miniaturek). 

Parametry są dodatkowymi cechami, które opisują działania podejmowane przez użytkowników w naszym serwisie, oprócz samej nazwy akcji. Jeśli mamy już zidentyfikowane zdarzenia, warto w dokumentacji zaznaczyć, które z nich są konwersjami. W Google Analytics 4 nazwa „konwersja” została zmieniona na „zdarzenia kluczowe”.

Kolejnym elementem zawartym w dokumentacji są wymiary, które szczegółowo charakteryzują zdarzenia. Wyróżniamy kilka rodzajów wymiarów. Istnieją wymiary opisujące konkretne zdarzenie, wymiary dotyczące użytkownika oraz wymiary dotyczące produktu. W dokumentacji poświęcamy osobne miejsce wymiarom opisującym produkty i e-commerce, gdzie dodatkowo przedstawiamy listingi, wyjaśniając znaczenie poszczególnych elementów. 

Charakterystyki produktów w e-commerce obejmują nazwę, kategorię, cenę i inne parametry. Ważne jest także uwzględnienie charakterystyk samej transakcji, takich jak podatki, waluta oraz koszty przesyłki. Dodatkowe parametry opisujące transakcje oraz promocje wewnętrzne w ramach modułu e-commerce także odgrywają istotną rolę. Oprócz śledzenia produktów, w e-commerce istnieje również koncepcja promocji wewnętrznej. To stanowi jeden z wymiarów analizy. 

Kolejnym istotnym elementem w dokumentacji technicznej są segmenty, które powinny zawierać nazwę segmentu oraz opis sposobu jego tworzenia. Na przykład, może to być segment użytkowników, którzy dokonali zakupu i pochodzą z określonego źródła ruchu. Jeśli często analizujemy grupę użytkowników lub nakładamy ten segment na nasze metryki, warto, aby definicja tego segmentu również została uwzględniona. Zapewni to spójność wiedzy i informacji w całej organizacji. W razie wątpliwości, każdy będzie mógł wrócić do jednego, jasno określonego źródła.

Kolejnym elementem dokumentacji są parametry oraz struktura tagowania UTM, czyli schemat oznaczania kampanii marketingowych. W tym schemacie powinny znaleźć się konkretne nazwy dla określonych grup kampanii oraz podstawowe nazwy parametrów, takie jak źródło/medium i kampania. Jeśli stosujemy niestandardowe grupowanie treści, konieczne jest dokładne określenie, które medium, źródło lub kampania należą do danej grupy kanałów.

Dobrze jest również, aby dokumentacja techniczna zawierała mechanizm, na przykład kalkulator, do tagowania kampanii. Jednym z narzędzi, które wykorzystujemy, jest prosty kalkulator dostępny online, umożliwiający wybieranie poszczególnych parametrów z listy rozwijanej. Dzięki temu unikamy pomyłek podczas tagowania kampanii zewnętrznej. 

Kolejnym elementem dokumentacji technicznej jest system raportowania. Dotyczy on schematów raportów, które znajdują się poza samym narzędziem Google Analytics 4 i są opisywane w kontekście innych narzędzi. W 90% przypadków wykorzystujemy Looker Studio. W podsumowaniu systemu raportowania określamy zakres, czyli wskazujemy, kogo dotyczy dany raport, jakie metryki są w nim używane, jaką wizualizację danych proponujemy, a także jaki jest okres widoczności tych danych.

Dodatkowo uwzględniamy konfigurację narzędzi, szczególnie Google Analytics 4, obejmującą konta, usługi, strumienie oraz definicje filtrów. Ostatnim elementem takiej dokumentacji jest specyfikacja warstwy danych. Jest ona potrzebna, kiedy ustalimy elementy biznesowe, takie jak pytania biznesowe, KPI wspierające działalność, zdarzenia i wymiary do tych zdarzeń. Następnie przychodzi czas na stworzenie i zakodowanie warstwy danych w serwisie.

Dokumentacja techniczna – jak ją stworzyć?

Jak wygląda proces tworzenia dokumentacji? Zazwyczaj, gdy rozpoczynamy współpracę z firmą, dokumentacja techniczna jest niekompletna lub nie istnieje. Na podstawie 15 lat doświadczenia w branży oraz realizacji setek audytów i wdrożeń Google Analytics, od wersji 2, przez Universal Analytics, aż po Google Analytics 4, możemy stwierdzić, że solidna dokumentacja jest kluczowa dla skutecznego wykorzystania narzędzi analitycznych. 

W wielu przypadkach, podczas rozpoczynania audytu, rzadko spotykamy się z istniejącą dokumentacją techniczną dotyczącą narzędzi analitycznych. Zazwyczaj taka dokumentacja jest tworzona w trakcie audytu, choć powinna powstać już na etapie wdrożenia narzędzia. 

Jeśli planujesz stworzenie takiej dokumentacji, warto zacząć od biznesowych elementów. Kolejnym krokiem jest analiza dostępnej warstwy danych, co często wymaga wewnętrznego audytu Google Analytics i Google Tag Manager. 

Utrzymywanie i rozwijanie tej dokumentacji często bywa pomijane w ferworze codziennych obowiązków. Dobrą praktyką jest regularna aktualizacja dokumentacji, zwłaszcza po każdej zmianie w konfiguracji. Regularne sprawdzanie danych to klucz do skutecznej analizy i optymalizacji działań. 

Dokumentacja techniczna powinna być dostępna w czasie rzeczywistym i asynchronicznie – czyli być dostępna dla wielu osób jednocześnie. Doskonale sprawdzają się tu narzędzia takie jak Google Spreadsheet, które często wykorzystujemy. Confluence również jest dobrym rozwiązaniem. 

Istotnym aspektem jest również proces aktualizacji. Warto zarezerwować czas w projekcie audytu, wdrożenia czy opieki analitycznej na regularne aktualizacje dokumentacji. Często w ferworze codziennych obowiązków zapomina się o niektórych istotnych aspektach pracy. Warto jednak poświęcić jeden dzień w roku na dokładną analizę naszych procesów, a także wyrywkowo, co miesiąc, sprawdzać wybrane elementy śledzenia. 

Oprócz samej konfiguracji narzędzi, należy regularnie rewidować dokumentację, aby upewnić się, że odpowiada ona aktualnym potrzebom biznesowym. Dobrą praktyką jest przeprowadzanie takiej rewizji raz w roku, zwłaszcza przy okazji podsumowania działalności firmy, kiedy przygotowuje się sprawozdanie finansowe. 

Analityka online ma na celu wspieranie decyzji biznesowych poprzez dostarczanie wartościowych danych, a jej właściwe wykorzystanie jest kluczowe dla efektywnego zarządzania firmą. Stosowanie cyklu PDCA (Plan, Do, Check, Act) przy wykorzystaniu danych online jest nieocenione w optymalizacji marketingu i produktów. 

Jednak jeśli mimo zgodności z planem, metryki i systemy raportowania wskazują na brak wzrostu biznesu, to jest to sygnał, aby zrewidować część biznesową dokumentacji. Należy przyjrzeć się celom, wyzwaniom, problemom i ograniczeniom organizacji oraz ich powiązaniu z konfiguracją danych. Jeśli działaliśmy zgodnie z danymi, a wyniki są niezadowalające, to prawdopodobnie nie analizujemy właściwych danych.

Wykorzystanie AI w tworzeniu i aktualizacji dokumentacji technicznej

Nowoczesne narzędzia AI rewolucjonizują proces przygotowywania dokumentacji – od automatycznego generowania treści po sugerowanie struktur i eliminowanie błędów. Dzięki sztucznej inteligencji firmy mogą szybciej tworzyć spójne i aktualne materiały, redukując nakład pracy manualnej i błędy ludzkie.

Automatyczna edycja i generowanie dokumentów z wykorzystaniem LLM

Modelom językowym (LLM) przypisuje się potencjał nie tylko do tworzenia draftów dokumentacji, ale też do ich rewizji i korekt w oparciu o najnowsze dane projektowe. Takie narzędzia pomagają zachować spójność terminologiczną oraz ułatwiają zgodność techniczną dokumentów.

Podsumowanie

Dokumentacja techniczna jest fundamentem prawidłowego wdrożenia danych online w organizacji oraz ich efektywnego wykorzystania w rozwoju biznesu. Mimo że może być to czasochłonny element pracy, prawidłowo prowadzona dokumentacja zapewnia odporność na zmiany w zespole i ułatwia integrację nowych członków. Dodatkowo, w przypadku zmian w serwisie i możliwej utraty śledzenia, dobrze prowadzona dokumentacja pozwala szybko odzyskać dane.

Zachęcam do stworzenia własnej dokumentacji, jeśli jeszcze jej nie posiadasz. Jest to krok, który zwiększy odporność twojej organizacji na zmiany i pozwoli skutecznie wykorzystać dane w podejmowaniu decyzji biznesowych.