Inżynieria i przekazanie
Daj projektowi pamięć, z której inni mogą skorzystać.
Architektura, interfejsy, sposób użycia: dokumentacja pomaga właściwym osobom zrozumieć narzędzie i decyzje stojące za nim.
Zakres, terminy i materiały uzgadniamy w ofercie.
Potrzeba
Kto ma zrozumieć i przejąć narzędzie?
Przydatny dokument odpowiada na konkretne pytanie określonego odbiorcy wtedy, gdy jest potrzebny.
Zespoły techniczne i biznesowe korzystające z produktu lub go przejmujące.
Przy oddaniu, przejęciu lub rozwoju systemu.
Nasze podejście
Dokumentować rzeczywiste potrzeby
Najpierw określić odbiorców i pytania, dopiero potem format, szczegółowość i dokumenty.
Architektura
Przystępnie wyjaśnić komponenty, zależności i decyzje kształtujące narzędzie.
Omów ten punktInterfejsy
Opisać potrzebną wymianę danych między systemami i miejsce przechowywania jej kontraktów.
Omów ten punktUtrzymanie
Opisać uzgodnione zadania związane z przejęciem lub utrzymaniem dla zainteresowanych osób.
Omów ten punktMC / SERVICES
Modułowy zestaw ułatwiający przejęcie
Zestaw może obejmować architekturę, wymianę danych, obsługę i wprowadzenie, zależnie od odbiorców i systemu.
Umowy interfejsów i wymiana.
Instrukcja operacyjna uzgodnionych zadań.
Instrukcja użytkowania wybranych ścieżek.
Aktualizować dokumentację razem z produktem
Studio może uzgodnić dokumenty z planowanymi zmianami kodu.
Klient wskazuje czytelników, zatwierdza użycie i zarządza zachowaniem dostępów.
Oznaczona wersja przy każdym przekazaniu.Dokumenty nie aktualizują się same: ich przechowywanie i zmiany wymagają ustaleń.
Etapy
Od odbiorców do użytecznych dokumentów
Etapy dostosowujemy do zlecenia i zaangażowanych osób.
- 01
Ustalić
Doprecyzować cele, dostępy i kryteria.
- 02
Wykonać
Zrealizować uzgodnione prace i przekazać ustalenia.
- 03
Przekazać
Wspólnie sprawdzić i przekazać uzgodnione materiały.
Możliwe materiały
Możliwe części dokumentacji
Ostateczną listę, format i kryteria przekazania uzgadniamy przed pracą.
Plan dokumentów i odbiorców.
Wybrane przewodniki lub schematy w uzgodnionych formatach.
Historia aktualizacji wykonanych podczas zlecenia.
Wyłączenia do ustalenia
- Brak uniwersalnego zestawu lub gwarantowanej liczby stron.
- Stałe aktualizacje lub szkolenie wymagają osobnej umowy.
Zakres
Co trzeba jeszcze zorganizować
Format, języki, szczegółowość i prawa do materiałów określa oferta.
Pytania
Pytania o dokumentację
Czy od razu trzeba opisać wszystko?
Nie. Najpierw ustalamy najważniejsze zastosowania i odbiorców, a potem odpowiedni poziom szczegółowości.
Jak utrzymać aktualność dokumentów?
Odpowiedzialność, terminy i sposób aktualizacji trzeba ustalić wraz ze zmianami produktu; stała opieka nie jest domyślna.
Następny krok
Zaplanujmy praktyczną dokumentację.
Powiedz, kto będzie czytać, używać lub przejmować narzędzie; ustalimy potrzebne materiały i sposób ich aktualizacji.