Inżynieria Oprogramowania Laboratorium mgr inż. Michał Bukowski randam@interia.eu

Projekt Dokumentacja składa się z dwu dokumentów: dokumentacji wymagań oraz projektu. Części opisowe można przygotować w dowolnym powszechnie używanym edytorze tekstów umożliwiającym wklejanie diagramów. W projekcie należy intensywnie wykorzystywać język UML. Całość projektu jest opatrzona wstępnymi stronami zawierającymi następujące elementy: Strona tytułowa wyszczególniająca nazwę projektu i jego Autorów. Streszczenie. Lista Autorów z podaniem czynności, którymi przyczynili się oni do powstania projektu.

Projekt Dokumentacja wymagań Należy odnieść się do Standardu wymogów IEEE, wpisując teksty w języku polskim.

Projekt Wstęp 1.1. Przeznaczenie tej dokumentacji wymagań 1.2. Zakres produktu 1.3. Definicje, akronimy i skróty 1.4. Odnośniki 1.5. Przegląd pozostałej części dokumentu Ogólny opis 2.1 Wizja produktu 2.2 Funkcje produktu 2.3 Charakterystyka użytkowników 2.4 Ogólne ograniczenia 2.5 Założenia i zależności Szczegółowe wymagania Dodatki Skorowidz.

Projekt Konieczne jest dokumentowanie (na przykład w dodatkach) istniejącej rzeczywistości w stopniu niezbędnym do dalszych prac projektowych: schematy organizacyjne, zakresy obowiązków, instrukcje, rozporządzenia, zarządzenia, kolejność wykonywanych czynności, tworzone i gromadzone dokumenty, obieg informacji, wykorzystywany sprzęt (niekoniecznie informatyczny), uwarunkowania prawne – ustawy, normy, przepisy, czynniki nieformalne.

Projekt Strona tytułowa wyszczególniająca nazwę projektu i jego autorów. Spis treści. Krótki wstęp omawiający zagadnienie (nawiązanie do dokumentacji wymagań), cele projektu, podstawowe wymagania klienta do tworzonego systemu, użyte narzędzia modelowania i zarys opracowania (streszczenie pozostałych rozdziałów). Szczegółowa analiza wymagań użytkownika. Wymagania przyszłych użytkowników opisane przypadkami użycia wraz ze scenariuszami. Na tym etapie mogą też być użyte diagramy czynności aby pokazać procesy biznesowe. Podstawowe obiekty: dane przechowywane w systemie, dokumenty wprowadzane do i wyprowadzane z systemu. Utworzenie słownika danych i wstępnych diagramów klas. Rozwinięcie przypadków użycia poprzez diagramy aktywności i sekwencji. Uszczegółowienie diagramów klas (uzupełnienie metod). Opis związków pomiędzy klasami. Opis algorytmów działania programu (ważniejszych metod) wraz z wyszczególnieniem punktów krytycznych. Powinny tu być użyte diagramy czynności oraz, w celu sprecyzowania zachowania obiektów, diagramy stanów.

Projekt Ustalenie co należy przechowywać w bazie danych, ilustracja bazy poprzez diagramy ERD (encja-związek) lub diagramy klas. Projekt interfejsu użytkownika. Założenia ogólne, lista dialogów, ekranów, formatek (może być w formie diagramów klas). Projekty ekranów. Nawigacja pomiędzy ekranami. Planowany wygląd ekranów. Przewidywane raporty (wydruki). System pomocy. Architektura systemu, diagramy komponentów i diagramy wdrożenia. Proponowany dobór narzędzi programistycznych. Napisać jakie narzędzia, języki programowania, itp. będą potrzebne do realizacji projektu. Proponowane wymagania sprzętowe i programowe, sygnalizacja specjalnych wymagań i ograniczeń np. co do pojemności bazy danych, obowiązkowego czasu przechowywania danych archiwalnych, okresowości przygotowywania raportów itp. Plan testowania, propozycje testów. Proponowany harmonogram implementacji projektu, podział zadań, przydział zasobów: osoby, czas, środki finansowe, sprzęt i oprogramowanie.

Projekt np. Cel projektu: zaprojektowanie aplikacji obsługującej bazę danych do zarządzania firmą/biblioteką/szkołą/przychodnią itp. Kolejne etapy projektu: Należy określić skład osobowy, przygotować temat i krótki opis projektu. Opis powinien zawierać listę grup użytkowników, którzy mogą zarządzać systemem oraz ich role. Każdy system musi uwzględniać administratora, który może zarządzać nim bez ograniczeń oraz co najmniej jedną inną grupę.

Projekt np. Kolejne etapy projektu: Należy określić skład osobowy, przygotować temat i krótki opis projektu. Opis powinien zawierać listę grup użytkowników, którzy mogą zarządzać systemem oraz ich role. Każdy system musi uwzględniać administratora, który może zarządzać nim bez ograniczeń oraz co najmniej jedną inną grupę.

Projekt np. Kolejne etapy projektu: Należy przygotować diagram związków (ERD) oraz diagram hierarchii funkcji (FHD). Diagram ERD powinien zawierać co najmniej 7 encji. Należy przygotować macierz CRUD (Create, Retrieve, Update, Delete) oraz diagram przepływu danych (DFD). Diagram DFD powinien składać się z diagramu ogólnego i diagramów szczegółowych. Należy przygotować diagram przypadków użycia (UCD) oraz wnioski na temat opracowanego projektu aplikacji oraz języka UML. W przypadku, gdy aplikacja jest zaimplementowana obiektowo (np. w ramach innego przedmiotu), poszczególne klasy, ich atrybuty oraz działania można przedstawić tak, aby reprezentowały pola i metody klas użytych w programie. We wnioskach można krótko opisać w jaki sposób i przy użyciu jakich narzędzi aplikacja została (lub będzie) zaimplementowana.

Projekt np. Kolejne etapy projektu: Przykładowe narzędzia, które umożliwiają tworzenie diagramów UML: - Violet UML Editor - MySQL Workbench (diagramy ERD) - StarUML - UMLet - ArgoUML - Oracle Designer W razie problemów ze znalezieniem lub uruchomieniem wygodnych narzędzi do tworzenia diagramów można je wykonać w programie MS Word (kształty), a nawet narysować ołówkiem na kartce i zeskanować. Należy pamiętać, że diagramy wraz z napisami powinny być czytelne.