Dokumentowanie systemów IT
System działa, ale… klient nie odbiera, a zespół męczy się
Zadowalaj klienta dokumentacją systemu IT – zajmiemy się tym.
Tworzymy dokumentację Waszego systemu, aby przeszedł przetarg, odbiór lub próbę czasu podczas utrzymania.
Problemy
- Tworzycie lub wdrażacie system IT, ale klient nie chce go odebrać? Uwagi do dokumentacji mnożą się, odbiór przeciąga, a kasa oddala?
- Ściągnij sobie ten problem z głowy. Skup się na wdrożeniu, a my pomożemy w dokumentacji.
- Twój zespół narzeka, że nie wiadomo jak to ma działać? Programiści i testerzy zamiast iść do przodu z robotą, ciągle cofają się i muszą ustalać raz jeszcze. Nie macie analityka ani nikogo od wymagań czy dokumentacji. Chcielibyście przyspieszyć produkcję.
- Pokażemy zespołowi jak pisać Wasze wymagania krótko, a raz i dobrze
- Jest TEN JEDEN architekt / programista, który WIE i ogarnia, ale nie ma czasu być na każdym spotkaniu, odpowiadać na każde pytanie, rozwiązywać każdego problemu, przekazywać informacje każdemu koledze czy koleżance z zespołu
- Zdejmiemy mu z głowy 80% pytań, które zadają na okrągło, będzie mógł odesłać do dokumentacji i zająć się prawdziwymi wyzwaniami na miarę swoich kompetencji i wynagrodzenia
- Wdrażanie pracownika trwa długo, kosztuje frustrację, gasi zapał. Nikt nie wie jak to działa, poznawanie systemu to klikanie w menu, w którego gąszczu każdy gubi się zapominając czego szukał. Każecie czytać “dokumentację” i taski? A w nowym człowieku coś powoli umiera - wiara w to, że robicie fajne rzeczy, których chce być częścią.
- Przyspieszymy wdrożenie, uprzyjemnimy pierwsze kontakty pracownika z systemem
- Podczas audytu przestajecie oddychać, kiedy pytają o dokumentację? Wiadomo, że zapytają, wiadomo, że trzeba, ale jakoś tak nie ma komu, kiedy, nie wiadomo jak.
- Zrobimy tak, żeby było dobrze, a Wam powiemy gdzie co jest
Usługa tworzenia dokumentacji systemu IT.
“Zrób to za nas” – tworzymy dokumentację systemu IT (projektu lub produktu) spełniającą potrzeby klienta, managerów, programistów, testerów, architektów, administratorów, UX designerów, analityków danych, itd.
“Naucz nas” – robimy audyt dokumentacji, warsztaty z zespołem, wnioski dla zespołu, rekomendacje jak działać lepiej, przykłady i szablony do użycia w Waszych projektach -> to opisujemy w osobnej usłudze – zobacz tu.
Jak to działa
- 1. Zgłaszasz się do nas na bezpłatną konsultację
- lub od razu zamawiasz usługę i kierujesz nas na spotkanie z zespołem
- 2. Poznajemy system, zadajemy pytania, przeglądamy materiały
- 3. Wykonujemy dokumentację systemu w kontakcie z Twoim zespołem
- a. pierwsze efekty zobaczysz po kilku dniach, sensowny i zweryfikowany komplet informacji po ok. 2 tygodniach, a jeśli chcesz dokładniej - kontynuujemy
- 4. Przekazujemy Twoim ludziom dokumenty i modele, które załatwią bieżące potrzeby a w przyszłości drastycznie skrócą czas przygotowania kolejnych dokumentacji
Ta usługa jest dla:
- Klient nie chce odebrać systemu z powodu kiepskiej dokumentacji
- Zespół narzeka, że brakuje dobrej dokumentacji, co hamuje ich pracę
- Jest TEN JEDEN architekt / programista, który WIE i ogarnia, ale nie ma czasu
- Tworzycie lub wdrażacie system IT
- Nie macie swojego analityka biznesowego
- ani nikogo kto profesjonalnie zajmuje się dokumentacją systemów
Ta usługa NIE jest dla:
- Macie swojego analityka biznesowego - > może lepiej rozwinąć jego kompetencje na szkoleniach lub mentoringu na przykładach Waszych projektów?
- Ktoś z zespołu bardzo chce zajmować się dokumentacją -> szkolenia, mentoring
- Oczekujecie zadowolenia klienta z systemu, który jest kiepski -> sama dokumentacja tego nie załatwi - jak to się mówi “Sh*t in - sh*t out”, potrzebujecie analizy biznesowej i projektowania od podstaw
- Oczekujecie, że opiszemy system, nie nadając priorytetu zadaniu i nie dając dostępu do zespołu go wytwarzającego, który ma wiedzę na jego temat -> nie chodzi o to, żeby naklepać dużo stron, ale żeby utrwalić i skondensować wiedzę
- Wasz klient oczekuje dokumentacji niczym NASA, będzie tylko użytkował system, a chce wiedzieć więcej niż inżynierowie go tworzący -> lista uwag może nie mieć końca, czy masz w umowie liczbę iteracji lub sensowne ograniczenie inwencji odbierającego
Korzyści
- Klient odbiera system i dostajesz pieniądze za zamówienie – załatwiamy sprawę nawet w ciągu kilku dni.
- Jeśli wdrażacie ten sam system różnym klientom po konfiguracji – tutaj korzyści potęgują się! Dokumentując raz, będziecie mieli po lekkim dostosowaniu materiał na wszystkie inne wdrożenia.
- Skracacie czas onboardingu nowych pracowników
- Pomagacie pracownikom sprawniej zdobywać informacje
- Z większą pewnością wprowadzacie zmiany i naprawy
- Ułatwiacie sobie przejście przez audyty jakości
Dokumentacja przechodzi weryfikację – jest wartościowa dla biznesu, managerów, programistów, testerów, UX designerów, administratorów, itd.
Przykładowe elementy dokumentacji, które tworzymy
- Kontekst użycia - wyzwania klienta, w których pomaga system
- Wspierane procesy biznesowe
- Zakres funkcjonalny systemu - funkcjonalności, przypadki użycia
- Zakres konfiguracji
- SLA, spełniane wymagania jakościowe
- Architektura logiczna systemu
- Architektura fizyczna systemu
- Opisy integracji
- Instrukcje użytkownika (User Guide)
- Dokumentacja wdrożeniowa i utrzymaniowa
Najczęstsze pytania (FAQ)
Czy muszę mieć gotowy system, żeby zacząć?
Nie. Wystarczy koncepcja rozwiązania w czyjejś głowie albo nawet potrzeba, bez pomysłu na implementację. Już wtedy można zrozumieć kontekst, zapisać wymagania, zacząć projektować system.
Z kim rozmawiasz – z programistami, PM-em, właścicielem?
Potrzebujemy dostępu do osób mających wiedzę o systemie. Im wyżej w strukturze, tym rzadziej i na krócej potrzebujemy. Im bliżej rozwiązania czy użytkowania, tym więcej szczegółów do omówienia. Przydaje się kontakt ze sponsorem, biznesem, klientem, programistami, architektem, testerami – im bardziej kompleksowo poznamy system, tym pełniejsza będzie dokumentacja. Pracujemy sprawnie i nie zabieramy nadmiernie czasu, ale potrzebujemy wiedzy dla jakości.
Ile czasu to zajmuje?
Dla prostych systemów i bogatej, choć chaotycznej dokumentacji – kilka dni. Dla średnich systemów, pewnych spisanych informacji i dostępu do zespołu – kilka tygodni. Dla bardzo rozbudowanych systemów i nieutrwalonej wiedzy, a potrzebie szczegółowej dokumentacji – kilka miesięcy.
W jakich narzędziach tworzysz dokumentację?
Sercem dokumentacji analitycznej jest model w Visual Paradigm. Można go eksportować do Worda, PDF, osadzać na Confluence, a także udostępniać do komentowania. Na modelu pracuje się wielokrotnie efektywniej niż na samych Wordach, Confluence, Draw.io, itd.
Czy możesz zaktualizować istniejącą dokumentację?
Jak najbardziej. Najczęściej jednak z naszych doświadczeń wynika, że klient prowadzi dokumentację w sposób nieoptymalny, używając dużo nieuporządkowanego tekstu, w narzędziach trudnych do sprawnego zarządzania. Rekomendujemy usprawnienia w metodzie opisywania systemu. Jeśli jednak jesteście bardzo uparci, możemy zostać przy Waszym sposobie. Często prowadzi to jednak też do wyższej wyceny, bo w ten sposób dokumentuje się dłużej.