Dokument Detaliczny Projektu

Transkrypt

1 Dokument Detaliczny Projektu Dla Biblioteki miejskiej Wersja 1.0

2 Streszczenie Niniejszy dokument detaliczny projektu(ddp) przedstawia szczegóły pracy zespołu projektowego, nad stworzeniem aplikacji bazodanowej wspomagającej organizację pracy i system wypożyczania książek w bibliotece miejskiej. Pierwsza część dokumentu zawiera opis ogólnych założeń projektowych. Druga część opisuje wykorzystane w projekcie komponenty.

3 Spis treści 1. Wprowadzenie Cel Zakres Definicje, akronimy i skróty Odsyłacze Omówienie Standardy projektu, konwencje, procedury Standardy projektowe Standardy dokumentacyjne Konwencje nazewnicze Standardy programistyczne Narzędzia Specyfikacja komponentów Logowanie Baza Pracownik l2prod-common-task mysql-connector-java bin Załączniki Harmonogram prac Interfejs aplikacji

4 1. Wprowadzenie 1.1. Cel Dokument DDP ma za zadanie przedstawić szczegółowo sposób realizowanych prac. Zgromadzone są w nim wszystkie informacje odnośnie budowy i działania oprogramowania. Określa on również założenia projektu, standardy, narzędzia i komponenty wchodzące w skład aplikacji Zakres Założeniem projektu jest stworzenie systemu informatycznego Biblioteka miejska, służącego do wspomagania organizacji pracy i systemu wypożyczania książek w bibliotece miejskiej. System ma służyć do przechowywania informacji o książkach posiadanych przez bibliotekę oraz książkach wypożyczonych. Aplikacja pozwoli na przechowywanie informacji o klientach oraz pracownikach. Umożliwi klientom przeglądanie dostępnych pozycji oraz rezerwowanie książek Definicje, akronimy i skróty Klient - zarejestrowany klient biblioteki posiadający własny login i hasło do systemu. Posiada możliwość przeglądania zasobów biblioteki oraz rezerwowania książek. Pracownik - pracownik biblioteki miejskiej posiadający własny login i hasło do systemu. Posiada możliwość przeglądania zasobów biblioteki, dodawania, edytowania już istniejących pozycji, dodawania nowych klientów, przeglądania książek wypożyczonych oraz zarezerwowanych. Rezerwacja - zarezerwowanie pozycji (książki) przez klienta w celu późniejszego wypożyczenia jej na określony czas. Książka może być zarezerwowana przez maksymalnie 5dni, jeżeli w tym czasie klient nie zgłosi się po jej odbiór, książka przestanie posiadać status zarezerwowanej. Zwrot książki - konkretna data, do której należy zwrócić książkę do biblioteki. Data ta może być przesunięta poprzez uzgodnienie tego z pracownikiem biblioteki ISBN - Międzynarodowy Znormalizowany Numer Książki niepowtarzalny 13-cyfrowy identyfikator książki.

5 1.4. Odsyłacze - Ustawa z dnia 29 sierpnia 1997 o ochronie danych osobowych (Dz. U nr 133 poz. 883 z późn. zm.) Omówienie Dokument ten powstał na bazie specyfikacji wymagań systemu określonych onych podczas pierwszych etapów projektowania systemu. Zawiera on definicje standardów, które będą przestrzegane podczas realizacji projektu. Dalsza część dokumentu zawiera informacje o narzędziach modułach i komponentach systemu oraz interfejsie graficznym aplikacji. 2. Standardy projektu, konwencje, procedury 2.1. Standardy projektowe Z uwagi na niewielkie doświadczenie zespołu dotyczące prac projektowych, wykorzystaliśmy model przyrostowy tworzenia oprogramowania. Model ten gwarantuje częste kontakty z klientem, wcześniejsze wykorzystanie i przetestowanie przez klientów gotowych elementów systemu a co za tym idzie mniejsze ryzyko porażki całego przedsięwzięcia Standardy dokumentacyjne Wszystkie dokumenty projektu są tworzone na podstawie jednego firmowego szablonu (papieru firmowego). Podczas tworzenia dokumentacji posługujemy się jednolitym i klarownym językiem wspólnym dla całego dokumentu. Podczas programowania aplikacji zostaną użyte komentarze, co umożliwi łatwą edycję kodu aplikacji nawet przez osoby nie związane z pracą projektową Konwencje nazewnicze Nazewnictwo w projekcie jest ukierunkowane na prostotę i jednoznaczność. W implementacji została zachowana konwencja nazewnictwa Java. Wersje dokumentów posiadają historie zmian tych dokumentów.

6 2.4. Standardy programistyczne Jako że system został zaprojektowany i stworzony w oparciu o język programowanie owanie JAVA. W projekcie będzie wykorzystywane podejście obiektowe do programowania oraz wykorzystywany będzie wzorzec projektowy MVC(Model-View View Controller). Aplikacja będzie tworzona zgodnie z wcześniejszymi założeniami i wcześniej ustalonym diagramem klas. Zaletami takiego podejścia jest brak zależności modelu od widoków aplikacji oraz łatwość dodawania oraz modyfikowania istniejących widoków bez wpływu na kluczową część systemu Narzędzia Do realizacji aplikacji wykorzystywany jest język Java. Wykorzystywane będzie środowiska RAD(Rapid Aplication Development) w postaci Oracle Eclipse, licencja Eclipse Public License. Podczas tworzenia dokumentacji, będziemy wykorzystywać StarUML oraz Microsoft Office Do tworzenia bazy danych posłużyło narzędzie Power designer. Narzędzia wykorzystywane podczas pracy nad systemem i dokumentacją: StarUML - producent Plastic Software, licencja Modified GPL, Microsoft office - producent Microsoft, licencja komercyjna, BusinessCards MX producent Mojosoft software, licencja testowa Diagram designer - producent MeeSoft, licencja freeware, Power designer - producent Sybase, licencja trial, Microsoft Paint - producent Microsoft, licencja zamknięte oprogramowanie Oracle Eclipse - producent Eclipse Foundation, licencja Eclipse Public License,

7 3. Specyfikacja komponentów 3.1. Logowanie Klasa odpowiedzialna za logowanie się do aplikacji. Odpowiada za wygląd okna logowania oraz obsługuje samą operację logowania i sprawdzania poprawności wprowadzonych danych (loginu i hasła). Klasa ta łączy się z bazą danych, odczytuje zawarte w bazie loginy i hasła klientów lub pracowników. Do jej zadań należy również porównanie wpisanych przez użytkownika danych (loginu i hasła) z rekordami bazy danych zawierających loginy i hasła. W razie udanego uwierzytelnienia pracownika, jest przenoszony do okna aplikacji umożliwiającego zarządzanie bazą danych biblioteki. W razie niepoprawnego uwierzytelnienia zostanie zgłoszony komunikat o nieprawidłowych danych Baza Klasa odpowiedzialna za połączenie z bazą danych. W niej są wykonywane ne wszystkie operacje odczytu i zapisu do bazy danych. Pozostałe klasy korzystają z klasy Baza w momencie kiedy muszą uzyskać dane z bazy danych lub zapisać dane do bazy. Klasa ta nie posiada interfejsu graficznego. Odpowiada tylko i wyłącznie z połączenie z bazą danych Pracownik Rozbudowana klasa tworząca interfejs pracownika, przedstawiający wszystkie przyciski i kontrolki potrzebne do dodawani i edycji bazy danych biblioteki tj. dodawania i usuwania książek, dodawania, blokowania klientów, dodawania i blokowania pracowników, dodawania i edytowania gatunków książek, dodawania i edytowania autorów książek, dodawania i edytowania wydawnictw książek. W klasie tej znajdują się również metody wywołujące zdarzenia w tej klasie. Klasa ta korzysta z klasy baza podczas łączenia się z bazą danych w celu dodania, usunięcia lub edytowania rekordów bazy danych 3.4. l2prod-common-task Komponent odpowiedzialny za menu w aplikacji. W programie zostało zaimplementowane menu JTaskPane widoczne po lewej stronie interfejsu pracownika mysql-connector-java bin Komponent odpowiedzialny dzialny za połączenie aplikacji z bazą danych w MySQL.

8 4. Załączniki 4.1. Harmonogram prac

9 Opis zadań harmonogramu prac: Zadanie1 ( ) - Uzgodnienie tematu projektu i wstępna umowa z klientem. Utworzenie grupy projektowej, ustalenie zasad współpracy wewnątrz grupy. Stworzenie protokołu z zebrania założycielskiego. Zadanie2 ( ) - Utworzenie harmonogramu prac, opracowanie dokumentacji wymagań użytkownika. Raport klienta, opracowanie raportu dla zleceniodawcy (opisanie zakresu przedsięwzięcia, przygotowanie szkicowego opisu: wymagań, modelu systemu, proponowanych rozwiązań, oszacowanie kosztów projektu i daty zakończenia projektu). Zadanie3 ( ) - Określenie wymagań funkcjonalnych projektu, opracowanie pełnej wersji specyfikacji wymagań (opracowanie słownika pojęć, przygotowanie listy wymagań funkcjonalnych i niefunkcjonalnych, zidentyfikowanie aktorów i ich funkcjonalności, przeprowadzenie identyfikacji przypadków użycia, opracowanie diagramu przypadków użycia.) Opracowanie stylu firmowego projektu (logo, wizytówkę, papier firmowy, szablon firmowy do opracowania dokumentacji projektowej). Zadanie4 ( ) - Wybranie metodyki analizy (strukturalna; obiektowa) która zostanie zastosowana w projekcie. Wybranie odpowiednich narzędzi CASE. Opracowanie zestawu diagramów, takich jak: diagram przypadków użycia, diagram klas, diagram przepływu danych. Zadanie5 ( ) - Wykończenie stylu firmowego projektu (loga, papieru firmowego) wprowadzenie stylu firmowego do projektu. Zadanie6 ( ) - Zaprojektowanie graficznego interfejsu użytkownika. Opracowanie słownika danych zawierający specyfikację modelu. Zadanie7 ( ) - Opracowanie diagramu związków encji, diagram przejść stanów, diagramu aktywności, diagramu sekwencji, diagramu współpracy, diagramu komponentów. Skorygowanie kosztorysu w oparciu o analizę. Konsultacje z klientem. Zadanie8 ( ) - Wybór narzędzi do szybkiego rozwijania aplikacji (ang. RAD - Rapid Application Development). Programowanie kolejnych etapów projektu (zaprogramowanie graficznego interfejsu użytkownika, podstawowych funkcjonalności i algorytmów). Zadanie9 ( ) - Zaprojektowanie modelu bazy danych (model konceptualny i model fizyczny), stworzenie bazy danych na potrzeby projektu. Zaprogramowanie dalszych funkcjonalności systemowych.

10 Zadanie10 ( ) - Dostosowanie projektu do ograniczeń i możliwości wybranego środowiska implementacji. Zaprogramowanie obsługi bazy danych i pozostałych funkcjonalności w projekcie. Wstępne testowanie aplikacji. Zadanie11 ( ) - Zakończenie programowania projektu. Przeprowadzenie szczegółowych testów, naprawa ewentualnych błędów w aplikacji. Finalizacja projektu. Sprawdzenie i zamknięcie dokumentacji. Przygotowanie projektu do zaprezentowania klientowi. Zadanie12 ( ) - Prezentacja projektu klientowi, zakończenie projektu Interfejs aplikacji Logowanie do aplikacji: Rysunek 1 - logowanie do aplikacji

11 Interfejs pracownika: Rysunek 2 - interfejs pracownika

12 Lista pracowników: Rysunek 3 - lista pracowników

13 Lista książek: Rysunek 4 - lista książek

14 Dodawanie książek: Rysunek 5 - dodawanie książek

15 Filtracja książek: Rysunek 6 - filtrowanie książek