Ukończyłem aplikację internetową, która jest zasadniczo opracowana w PHP i jest po prostu kolejną zwykłą aplikacją internetową. Zwykle po dostarczeniu ostatecznej wersji produkcyjnej przekazuję klientowi dokumentację kodu i informacje o architekturze. Jednak w przypadku tego konkretnego projektu klient nalega na posiadanie pełnych danych wejściowych i wyjściowych dotyczących projektu.
Zastanawiam się więc ... Jakie są obowiązkowe dokumenty techniczne i nietechniczne, które mogę przekazać klientowi oprócz dokumentacji kodu i dokumentacji?
(Fajnie byłoby też uderzyć klienta w różne statystyki i dane dotyczące projektu, aby wiedział, ile pracy wymaga i jak fajny jest ten produkt.)
Odpowiedzi:
Myślę, że lista powinna zawierać:
Nie wszystkie z tych rzeczy mogą być dostępne (lub konieczne) dla każdego projektu, ale myślę, że jest to dobry ogólny przewodnik.
źródło
Oprócz naprawdę dobrej odpowiedzi FrustratedWithFormsDesigner chciałbym powiedzieć, co zawierają dokumenty nietechniczne (tak jak to zrobiliśmy):
oferta, którą złożyłeś:
które razem stanowią rodzaj umowy o tym, co musisz zrobić i czego oczekujesz
od klienta podczas rozwoju, a także szacowanego czasu i kosztów.
specyfikacja, w tym protokoły przeglądu, przypadki użycia i plany testów, wyniki testów
projekt w UML i wszystkie odpowiednie dokumenty
dokumentacja kodu źródłowego (doksygen lub cokolwiek innego)
instrukcja obsługi i wytyczne dotyczące instalacji
ostateczna faktyczna ilość zasobów (czasu i pieniędzy) wykorzystanych w projekcie, dzięki czemu można wystawić fakturę
niektórzy klienci chcą również protokołów ze spotkań, które stanowią rozszerzenie wspomnianego wyżej „dokumentu decyzji”
Mam nadzieję, że tego właśnie szukałeś.
źródło
Postępuj zgodnie z dokumentacją, która ma zastosowanie do twojego projektu, z poniższych. Być może masz już niektóre z nich.
Dokumentacja techniczna:
Przygotuj dokumenty ze zrzutami ekranu i zaznacz odpowiedni kod (jeśli to konieczne), aby:
Wprowadź nieprawidłowe dane i pokaż, że jest to niemożliwe, ponieważ sprawdziłeś poprawność danych w interfejsie użytkownika i zapleczu.
/* This step is not applicable if you have not used any object for getting direct input from the user like Text Field as it is obvious that you cannot get invalid data through indirect input. */
Pokaż, że w programie lub kliencie nie ma błędu w programie ani niespójności w danych, wyjaśniając odpowiedni kod.
Powinieneś je sam sprawdzić przed udokumentowaniem, aby jeśli Twój klient poprosił o wersję demonstracyjną z przykładowymi danymi, możesz pokazać, jak projekt faktycznie działa, a także upewnić się, że kod frontonu ma odpowiednie wiersze komentarza.
Na koniec podsumuj statystyki, takie jak całkowita liczba wierszy kodu, całkowita liczba dni spędzonych na projekcie, całkowita liczba sprawdzeń projektu, lista wszystkich używanych aplikacji oraz inne informacje techniczne i nietechniczne.
Dokumentacja nietechniczna:
źródło
Uważać
Potencjał dokumentacji, które mogłyby dać klientowi jest praktycznie nieograniczone. Dodatkowy czas potrzebny na wygenerowanie dokumentacji, której jeszcze nie masz, jest nieopłacony.
Dlaczego klient chce tej dokumentacji (ponad kod źródłowy)? Co z tym zrobisz? Dla kogo to jest?
Odpowiedzi na te pytania pomogą zawęzić zakres tego, co należy dostarczyć.
Bardzo ważne jest, abyś ty i klient dokładnie uzgodnili, jaką dokumentację dostarczyć i czy dodatkowe wysiłki zostaną zrekompensowane.
Nie graj w zgadywanie. Większość dokumentacji technicznej byłaby bezużyteczna dla typowego (nietechnicznego) klienta.
źródło
Prawdopodobnie podzieliłbym to na kilka kategorii dokumentów:
Przewodniki:
Wsparcie:
Punkty integracji:
źródło