DOKUMENTACJA ZBIORCZA APLIKACJI ORGANIZER

Transkrypt

1 Projekt zespołowy autorzy: Mateusz Hendzel, Marcin Pieślak, Wiktor Nitka, Mateusz Myk, Kamil Lorenc DOKUMENTACJA ZBIORCZA APLIKACJI ORGANIZER Spis treści: 1. Protokół założycielski Specyfikacja wymagań Harmonogram Diagram przypadków użycia Prototyp GUI Logo Zespołu, Logo Aplikacji, Wizytówka Zespołu Diagram domeny Scenariusz przypadków użycia Diagram klas wdrożeniowy Testowanie Aplikacji Dokument Detaliczny Projektu Wprowadzenie Opis Ogólny Specyfikacja Komponentów Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 1

2 1. PROTOKÓŁ ZAŁOŻYCIELSKI Autor: Mateusz Hendzel Sprawdzone przez Wiktor Nitka Koszalin dn r. Protokół założycielski 1. Grupa projektowa. W dniu 26 lutego 2014 roku w Koszalinie odbyło się zebranie, którego celem było utworzenie grupy projektowej. W zebraniu wzięli udział studenci III roku Informatyki z Politechniki Koszalińskiej. Wybrano grupę projektową na podstawie osobistych preferencji. W jej skład wchodzą: Mateusz Hendzel Marcin Pieślak Mateusz Myk Wiktor Nitka Kamil Lorenc 2. Rozwiązanie grupy Z dniem końca sesji egzaminacyjnej następuje rozwiązanie grupy z możliwością przedłużenia jej działania za zgodą wszystkich członków. 3. Cel projektu. Grupa projektowa została stworzona by zrealizować projekt zespołowy, którego celem jest wytworzenie Aplikacji Organizer na platformy mobilne oraz napisanie niezbędnej dokumentacji szczegółowo opisującej aspekty projektu. 4. Termin projektu. Członkowie zobowiązali się do wykonania projektu w nieprzekraczalnym terminie do końca sesji egzaminacyjnej VI semestru. W przypadku niedotrzymania terminu istnieją silne motywy, aby wszyscy członkowie grupy stracili możliwość zaliczenia przedmiotu. 5. Kierownik projektu. Członek grupy Mateusz Hendzel samodzielnie mianował się na stanowisko kierownika projektu. Nie ma możliwości odwołania lub zmiany lidera. Członkowie zespołu są zobowiązani do przestrzegania zasad i reguł ustalonych przez lidera grupy. 6. Obowiązki członków. Obowiązkiem każdego członka zespołu jest działanie na jego korzyść, aktywne uczestniczenie w projekcie oraz wywiązywanie się z przydzielonych zadań w Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 2

3 wyznaczonym terminie. 7. Kary W przypadku niewywiązywania się z obowiązków, kierownik może podjąć decyzję o wydaleniu z grupy. Każdy członek może podjąć decyzję o samodzielnym wystąpieniu z projektu. Wydalenie z grupy oraz samodzielnie wystąpienie z projektu wiąże się z obowiązkiem uiszczenia kwoty pieniężnej na rzecz rozwoju projektu w wysokości zł, chyba że kierownik postanowi inaczej. 8. Postanowienia końcowe Każdy z członków dobrowolnie przystąpił do projektu i podporządkowuje się treści niniejszego dokumentu, protokół założycielski sporządzono w pięciu jednobrzmiących egzemplarzach potwierdzonych podpisami wszystkich członków projektu. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 3

4 2. SPECYFIKACJA WYMAGAŃ Autor: Wiktor Nitka Zatwierdzone przez Mateusz Hendzel Specyfikacja Wymagań 1. Temat: Organizer na bazie kalendarza na platformę Android. 2. Potencjalni użytkownicy: Klienci usługi Google Play. 3. Klienci: Klienci usługi Google Play. 4. Funkcjonalności: Ekran powitalny Wybór widoku o Widok miesiąca Możliwość przewijania widoku o Widok Tygodnia Możliwość przewijania widoku o Widok dnia Możliwość przewijania widoku o Widok listy zdarzeń w porządku chronologicznym Możliwość przewijania widoku Zaznaczenie dowolnego dnia, godziny Utworzenie kopii zapasowej na karcie pamięci o Wybór ścieżki Utworzenie notatki(szybka notatka bez parametrów zdarzenia np. lista zakupów) o Nadanie tytułu notatki o Nadanie treści notatki o Edycja notatki o Usunięcie notatki Utworzenie zdarzenia(np. Spotkanie, urodziny, imieniny) o Nadanie tytułu zdarzenia o Nadanie typu zdarzenia o Przesunięcie zdarzenia na inny dzień/godzinę o Nadanie początku i końca zdarzenia o Dodanie alarmu do zdarzenia o Nadanie priorytetu dla zdarzenia o Nadanie opisu dla zdarzenia o Nadanie etykiety dla zdarzenia: prywatny, służbowy o Usuwanie zdarzenia o Edycja wcześniej utworzonego zdarzenia o Ustawienie cykliczności zdarzenia 5. Ograniczenia: Program na platformę Google Android w wersji 3.0 wzwyż, na urządzenia mobilne. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 4

5 3. HARMONOGRAM Autor: Mateusz Hendzel Sprawdzone przez Mateusz Hendzel Harmonogram Projektu Data Planowana data Osoba Zadanie Postęp rozpoczęcia zakończenia Do Mateusz Stworzyć protokół założycielski Hendzel Utworzyć Harmonogram projektu Do Marcin Pieślak Do Wiktor Nitka Do Marcin Pieślak Do Kamil Lorenc Do Mateusz Myk Do Mateusz Hendzel Do Wiktor Nitka Do Marcin Pieślak Do Wiktor Nitka Do Mateusz Hendzel Do Marcin Pieślak Do Marcin Pieślak Do Kamil Lorenc Do Mateusz Myk Do Mateusz Hendzel Podział obowiązków Założenie konta na platformie do komunikacji między członkami zespołu Specyfikacja wymagań Diagram przypadków użycia Projekt intefejsu GUI LOGO aplikacji Czynności papiernicze Model domeny Scenariusze Wybór bibliotek i narzędzi deweloperskich Diagram Klas Dokument Detaliczny Projektu Implementacja bibliotek Programowanie funkcjonalności Plan testów i testy statyczne Testy dynamiczne Końcowa wersja aplikacji Poprawiona Poprawiony Odłożono Wykonany Wykonany Wykonany Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 5

6 4. DIAGRAM PRZYPADKÓW UŻYCIA Autor: Wiktor Nitka Zatwierdzony przez Mateusz Hendzel Rys. 1. Diagram przypadków użycia Grupa Projektowa ANDROX kontakt: 6

7 5. PROTOTYP GUI Autor: Marcin Pieślak Zatwierdzony przez Mateusz Hendzel Rys. 2. Projekt interfejsu graficznego wykonany w środowisku ADT Eclipse Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 7

8 6. LOGO ZESPOŁU, LOGO APLIKACJI, WIZYTÓWKA ZESPOŁU Autor: Kamil Lorenc Zatwierdzony przez Mateusz Hendzel Rys. 3. Logo zespołu projektowego AndroX Rys. 4. Logo aplikacji Organizer Grupa Projektowa ANDROX kontakt: 8

9 Rys. 5. Wizytówka zespołu projektowego AndroX Grupa Projektowa ANDROX kontakt: 9

10 7. DIAGRAM DOMENY Autor: Mateusz Hendzel Sprawdzony przez Mateusz Hendzel Rys. 6. Diagram domeny Grupa Projektowa ANDROX kontakt: 10

11 8. SCENARIUSZ PRZYPADKÓW UŻYCIA Autor: Wiktor Nitka, Kamil Lorenc, Mateusz Myk, Mateusz Hendzel Sprawdzony przez Mateusz Hendzel Przypadek użycia: Zarządzanie notatkami. Przebieg podstawowy. 1. Użytkownik wybiera widok notatek. 2. System wyświetla widok notatek. Scenariusz Przypadków użycia 3. Użytkownik wybiera z menu opcję Utwórz notatkę 4. System wyświetla formularz tworzenia notatki. 5. Użytkownik wprowadza tytuł notatki. 6. Użytkownik wprowadza treść notatki. 7. Użytkownik wybiera opcję zapisu notatki. 8. System zapisuje notatkę do pliku. Przebieg alternatywny Użytkownik wybiera widok notatek. 2. System wyświetla widok notatek. 3. Użytkownik wybiera istniejącą notatkę. 4. System wyświetla wybraną notatkę z możliwością edycji. 5. Użytkownik edytuje notatkę. 6. Użytkownik wybiera opcję zapisu notatki. 7. System nadpisuje notatkę w pliku. Przebieg alternatywny Użytkownik wybiera widok notatek. 2. System wyświetla widok notatek. 3. Użytkownik wybiera istniejącą notatkę. 4. System wyświetla wybraną notatkę z możliwością edycji. 5. Użytkownik wybiera opcję usunięcia notatki. 6. System usuwa notatkę z pliku. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 11

12 Przypadek użycia: Zarządzanie zdarzeniami. Przebieg podstawowy. 1. Użytkownik wybiera dzień do którego chce dodać zdarzenie. 2. System wyświetla widok zdarzeń wybranego dnia. 3. Użytkownik wybiera z menu opcję Utwórz zdarzenie 4. System wyświetla formularz tworzenia zdarzenia. 5. Użytkownik wprowadza tytuł zdarzenia. 6. Użytkownik wprowadza typ zdarzenia. 7. Użytkownik ustawia początek i koniec zdarzenia. 8. Użytkownik dodaje alarm do zdarzenia. 9. Użytkownik ustawia priorytet zdarzenia. 10. Użytkownik nadaje etykietę zdarzenia. 11. Użytkownik wybiera opcję zapisu zdarzenia. 12. System zapisuje zdarzenie w pliku. Przebieg alternatywny Użytkownik wybiera dzień do którego chce dodać zdarzenie. 2. System wyświetla widok zdarzeń wybranego dnia. 3. Użytkownik wybiera istniejące zdarzenie. 4. System wyświetla zdarzenie do edycji. 5. Użytkownik edytuje zdarzenie. 6. Użytkownik wybiera opcję zapisu zdarzenia. 7. System nadpisuje zdarzenie w pliku. Przebieg alternatywny Użytkownik wybiera dzień z którego chce usunąć zdarzenie. 2. System wyświetla widok zdarzeń wybranego dnia. 3. Użytkownik wybiera istniejące zdarzenie. 4. System wyświetla zdarzenie do edycji. 5. Użytkownik wybiera opcję usunięcia zdarzenia. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 12

13 6. System usuwa zdarzenie z pliku. Przebieg alternatywny Użytkownik wybiera widok chronologiczny zdarzeń. 2. Wyświetla widok chronologiczny zdarzeń. 3. Użytkownik wybiera istniejące zdarzenie. 4. System wyświetla zdarzenie do edycji. 5. Użytkownik edytuje zdarzenie. 6. Użytkownik wybiera opcję zapisu zdarzenia. 7. System nadpisuje zdarzenie w pliku. Przebieg alternatywny Użytkownik wybiera widok chronologiczny zdarzeń. 2. Wyświetla widok chronologiczny zdarzeń. 3. Użytkownik wybiera istniejące zdarzenie. 4. System wyświetla zdarzenie do edycji. 5. Użytkownik wybiera opcję usunięcia zdarzenia. 6. System usuwa zdarzenie z pliku. Przypadek użycia: Wybór widoku. Przebieg podstawowy. 1. System wyświetla widok domyślny aplikacji. 2. Użytkownik wybiera z menu opcję zmiany widoku. 3. System wyświetla menu z dostępnymi widokami. 4. Użytkownik wybiera konkretny widok. 5. System wyświetla widok wybrany przez użytkownika. Przypadek użyci: Utworzenie kopii zapasowej. Przebieg podstawowy. 1. Użytkownik wybiera z menu opcję utworzenia kopii zapasowej. 2. System wyświetla formularz ze Ścieszką gdzie ma zostać zapisana kopia. 3. Użytkownik wypełnia formularz ze ścieżką. 4. System tworzy kopię zapasową plików pod wybraną ścieżką. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 13

14 9. DIAGRAM KLAS WDROŻENIOWY Autor: Wiktor Nitka Zatwierdzony przez Mateusz Hendzel Rys. 7. Diagram klas wdrożeniowy Grupa Projektowa ANDROX kontakt: 14

15 10. TESTOWANIE APLIKACJI Autor: Kamil Lorenc Zatwierdzony przez Mateusz Hendzel PLAN TESTOWANIA APLIKACJI 1. Sprawdzenie czy aplikacja prawidłowo dodaje i usuwa przypomnienia. 2. Sprawdzenie czy dodane przypomnienie zostanie wyświetlone (przypomniane) mimo wielokrotnego restartu telefonu. 3. Sprawdzenie zachowania aplikacji w wypadku dodania wielu przypomnień o różnych datach, godzinach i priorytetach. 4. Sprawdzenie czy program wyświetla przypomnienie po nieustannym działaniu przez kilka dni. 5. Sprawdzenie czy jest możlliwość dodania do kalendarza dwukrotnie identycznego przypomnienia (ta sama minuta, godzina, priorytet). 6. Sprawdzenie zachowania programu w przypadku nadawania nazw przypomnień przy użyciu małych i dużych liter, cyfr oraz znaków specjalnych. 7. Test zapisywania do pliku dodanych wydarzeń i ich odczytu w przypadku crashu aplikacji. 8. Sprawdzenie czy zmiana daty w ustawieniach urządzenia, nie powoduje błędnego wyświetlenia przypomnienia przez program. PRZEPROWADZENIE TESTOWANIA APLIKACJI Lp. Opis zadania Wykonana ilość testów Rezultat 1. Sprawdzenie czy aplikacja prawidłowo dodaje i usuwa przypomnienia. 2. Sprawdzenie czy dodane przypomnienie zostanie wyświetlone (przypomniane) mimo wielokrotnego restartu telefonu. 3. Sprawdzenie zachowania aplikacji w wypadku dodania wielu przypomnień o różnych datach, godzinach i priorytetach. 25 Test zaliczony, program pomyślnie wykonał operacje. 10 Test zaliczony, program wyświetla przypomnienie mimo wielokrotnego restartu urządzenia. 25 Test zaliczony, wszystkie przypomnienia zostały dodane i wyświetlone prawidłowo. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 15

16 4. Sprawdzenie czy program wyświetla przypomnienia po nieustannym działaniu przez kilka dni. 5. Sprawdzenie czy jest możlliwość dodania do kalendarza dwukrotnie identycznego przypomnienia (ta sama minuta, godzina, priorytet). 6. Sprawdzenie zachowania programu w przypadku nadawania nazw przypomnień przy użyciu małych i dużych liter, cyfr, oraz znaków specjalnych. 7. Test zapisywania do pliku dodanych wydarzeń i ich odczytu w przypadku crashu aplikacji. 8. Sprawdzenie czy zmiana daty w ustawieniach urządzenia nie powoduje błędnego wyświetlenia przypomnienia przez program. 1 Test zaliczony, mimo jednego crashu programu, przypomnienia zostały wyświetlone prawidłowo. 20 Test zaliczony, program wyświetla komunikat, że takie przypomnienie już istnieje. 25 Test zaliczony, program zapisał i wyświetlił prawidłowo wszystkie przypomnienia. 20 Test zaliczony, program po ponownym uruchomieniu poprawnie odczytał dane z pliku i wyświetlił przypomnienia. 20 Test zaliczony, program wyświetla przypomnienie w czasie, który pokrywa się z czasem urządzenia. Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 16

17 11. DOKUMENT DETALICZNY PROJEKTU Autor: Mateusz Hendzel, Marcin Pieślak Sprawdzony przez Mateusz Hendzel DOKUMENT DETALICZNY PROJEKTU (DDP) APLIKACJI ORGANIZER wersja: 2.0 Streszczenie Niniejszy dokument detaliczny projektu (DDP) opisuje detale pracy zespołu projektowego, który skupia się na stworzeniu aplikacji Organizer na platformę Google Android. Pierwsza część dokumentu zawiera opis ogólnych założeń projektowych, a także wykorzystywanych standardów i konwencji. Druga część ma na celu ogólną charakterystykę projektowanej aplikacji oraz jej aspektów. Wszystkie zmiany w dokumencie są odnotowane w historii zmian dokumentu zamieszczonej poniżej. Spis treści: 1. WPROWADZENIE Cel DDP Zakres DDP Definicje, akronimy, skróty Odsyłacze Krótkie omówienie dokumentu OPIS OGOLNY Standardy projektowe Standardy dokumentacyjne Konwencje nazewnicze Standardy programistyczne Narzędzia rozwijania oprogramowania SPECYFIKACJA KOMPONENTOW Typ Cel Funkcja Komponenty podporządkowane Zależności Interfejsy Zasoby Odsyłacze 20 Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 17

18 1. WPROWADZENIE 1.1 Cel DDP DDP jest centralnym dokumentem, w którym zgromadzone są wszystkie informacje odnośnie budowy i działania oprogramowania. Dokument powinien być zorganizowany w taki sam sposób, w jaki zorganizowane jest oprogramowanie. DDP powinien być kompletny, odzwierciedlający wszystkie wymagania zawarte w specyfikacji wymagań. Powinien również być wystarczająco detaliczny aby umożliwić implementację i pielęgnację kodu. Styl DDP powinien być systematyczny i rygorystyczny, a język i diagramy użyte w DDP muszą być klarowne. Wszystkie ważne terminy będą zdefiniowane i użyte w zdefiniowanym znaczeniu. Materiał, który nie mieści się w podanej zawartości dokumentu, będzie załączony jako dodatek. 1.2 Zakres DDP. Założeniem projektu jest stworzenie interaktywnego organizera opartego na graficznej wizualizacji kalendarza z możliwością przypisywania do dni zadań. Aplikacja wzbogacona będzie też innymi praktycznymi funkcjonalnościami. Program projektowany jest na platformy mobilne z systemem operacyjnym Android. Realizacja projektu odbywa się na komputerze osobistym (notebook) z systemem operacyjnym Windows 7. Środowisko programistyczne wykonywania projektu to program ADT Eclipse. 1.3 Definicje, akronimy, skróty. Aplikacja - ogólna nazwa dla oprogramowania, oferuje użytkownikowi określone funkcjonalności. Aplikacja mobilna ogólna nazwa dla oprogramowania działającego na urządzeniach przenośnych, takich jak telefony komórkowe, smartfony, palmtopy czy tablety, które pisane są przy użyciu określonych platform i języków programowania. Android - jest darmową platformą dla telefonów komórkowych. Platforma Android zawiera zintegrowany zestaw oprogramowania dla urządzeń mobilnych. W skład Platformy wchodzi system operacyjny, oprogramowanie pośrednie (middleware), interfejs i aplikacje. Notatka - krótki tekst o charakterze informacyjnym, nastawiony na przekaz danych, wyróżniający się zrozumiałością przedstawianych wiadomości: rzeczowością i zwięzłością. Urządzenie mobilne - (przenośne) urządzenie elektroniczne pozwalające na przetwarzanie, odbieranie oraz wysyłanie danych bez konieczności utrzymywania przewodowego połączenia z siecią (telefonu komórkowe, tablety, palmptopy). Priorytet ranga przypisana do konkretnego zdarzenia, informująca o jego ważności i znaczeniu Zdarzenie /Wydarzenie funkcjonalność zawierająca tytuł, opis, czas, priorytet, powiadomienie oraz przypisaną datę, mająca na celu zapisanie i przypomnienie użytkownikowi o nadchodzącym wydarzeniu którego spodziewa się w przyszłości Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 18

19 1.4 Odsyłacze. Nie dotyczy. 1.5 Krótkie omówienie treści dokumentu Dokument ten powstał na bazie specyfikacji wymagań systemowych. Zawiera on definicje standardów, strategii i konwencji, które będą przestrzegane podczas realizacji projektu. Dalsza część dokumentu zawiera informacje o modułach i komponentach systemu i interfejsie graficznym aplikacji. 2. OPIS OGÓLNY 2.1 Standardy Projektowe Podczas tworzenia projektu wykorzystamy model przyrostowy tworzenia oprogramowania. Wybraliśmy go, ze względu na jego zalety: -Klienci nie muszą czekad na dostarczenie całego systemu, zanim zaczną czerpad z niego korzyśd. -Klienci mogą używad wstępnych przyrostów jako rodzaju prototypu i zdobywad doświadczenia, które inspirują wymagania wobec późniejszych przyrostów. -Ryzyko całkowitej porażki przedsięwzięcia jest mniejsze. -Usługi o najwyższym priorytecie będą dostarczane jako pierwsze. -Łatwośd powrotu do prawidłowo działającej wersji programu w przypadku błędów 2.2 Standardy Dokumentacyjne Wszystkie dokumenty będą utworzone na podstawie jednego szablonu. W miarę możliwości (ze względu na ich czytelność i łatwość w zrozumieniu) będą tworzone diagramy przedstawiające dane zagadnienie. Przy programowaniu w języku Java będziemy stosować komentarze w stylu JavaDoc, co umożliwi proste wygenerowanie czytelnej dokumentacji kodu źródłowego aplikacji 2.3 Konwencje nazewnicze Nazewnictwo zastosowane w projekcie będzie ukierunkowane na jednoznacznośd i prostotę. Zarówno komponenty, jak i poszczególne funkcje będą nazywane w ten sposób by można było jednoznacznie odczytad cel danej funkcji czy komponentu. 2.4 Standardy Programistyczne W projekcie będziemy wykorzystywać podejście obiektowe do programowania. Będziemy wykorzystywać wzorzec projektowy MVC(Model-View Controller). Zalety takiego podejścia: Brak zależności modelu od widoków aplikacji Łatwość dodawania oraz modyfikowania istniejących widoków bez wpływu na kluczową część stystemu Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 19

20 2.5 Narzędzia Rozwijania oprogramowania Do realizacji projektu wykorzystujemy język JAVA (na platformę Android). Będziemy korzystać ze środowiska Android Development Tool Oracle Eclipse, licencja Public License. Podczas tworzenia dokumentacji, będą wykorzystywane m.in. programy: -StarUml program do tworzenia diagramów UML, -Sorgeforge.net platforma do komunikacji członków zespołu programistycznego -Microsoft Office pakiet oprogramowania wykorzystywany przy tworzeniu dokumentacji. 3. SPECYFIKACJA KOMPONENTÓW 3.1 Typ Graficzny komponent kalendarza typu Grid View z Grid Adapter 3.2 Cel Wykorzystanie komponentu jako kalendarza z możliwością zaznaczania daty oraz organizowania przypomnień. 3.3 Funkcja Prezentacja dni w widoku miesiąca oraz wskazanie bieżącego i wybranego dnia. 3.4 Komponenty podporządkowane Grid View Grid Cell Button Label 3.5 Zależności Nie dotyczy 3.6 Interfejsy onselecteddaychange view The view associated with this listener. year The year that was set. month The month that was set [0-11]. dayofmonth The day of the month that was set. 3.7 Zasoby Grafika 3.8 Odsyłacze Grupa Projektowa ANDROX kontakt: grupa.projektowa.pk@gmail.com 20