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.

MC / SERVICES Dokumentacja
  1. 01Architektura
  2. 02Interfejsy
  3. 03Utrzymanie

MAESTRO • Dokumentacja

MC / SERVICESDokumentacja

Potrzeba

Kto ma zrozumieć i przejąć narzędzie?

Przydatny dokument odpowiada na konkretne pytanie określonego odbiorcy wtedy, gdy jest potrzebny.
Dla kogo?

Zespoły techniczne i biznesowe korzystające z produktu lub go przejmujące.

W jakiej sytuacji?

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.

01

Architektura

Przystępnie wyjaśnić komponenty, zależności i decyzje kształtujące narzędzie.

Omów ten punkt
02

Interfejsy

Opisać potrzebną wymianę danych między systemami i miejsce przechowywania jej kontraktów.

Omów ten punkt
03

Utrzymanie

Opisać uzgodnione zadania związane z przejęciem lub utrzymaniem dla zainteresowanych osób.

Omów ten punkt

MC / 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.

A1 / 04

Notatka architektoniczna i decyzje.

A2 / 04

Umowy interfejsów i wymiana.

A3 / 04

Instrukcja operacyjna uzgodnionych zadań.

A4 / 04

Instrukcja użytkowania wybranych ścieżek.

010203

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.

  1. 01

    Ustalić

    Doprecyzować cele, dostępy i kryteria.

  2. 02

    Wykonać

    Zrealizować uzgodnione prace i przekazać ustalenia.

  3. 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ą.

01

Plan dokumentów i odbiorców.

02

Wybrane przewodniki lub schematy w uzgodnionych formatach.

03

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.

Porozmawiajmy o projekcie