<Nazwa firmy> <Nazwa projektu> Specyfikacja dodatkowa. Wersja <1.0>

Transkrypt

1 <Nazwa firmy> <Nazwa projektu> Wersja <1.0> [Uwaga: Niniejszy wzór dostarczony jest w celu użytkowania z Unified Process for EDUcation. Tekst zawarty w nawiasach kwadratowych i napisany błękitną kursywą (styl=infoblue) to wskazówki dla autora dokumentacji, które powinny zostać usunięte przed publikacją dokumentu.]

2 Historia zmian Data Wersja Opis Autor <dd/mm/rrrr> <x.x> <opis zmian> <imię i nazwisko> Poufne <Nazwa firmy>, 2009 Strona 2

3 Spis treści 1. Wprowadzenie Cel Zakres Pojęcia Odniesienia Streszczenie 4 2. Założenia i zależności 4 3. Używalność <Pierwsze wymaganie używalności> 4 4. Niezawodność <Pierwsze wymaganie niezawodności> 5 5. Wydajność <Pierwsze wymaganie wydajności> 5 6. Kompatybilność <Pierwsze wymaganie kompatybilności> 5 7. Ograniczenia projektowe <Pierwsze ograniczenie projektowe> 5 8. Bezpieczeństwo 5 9. Wymagania dotyczące instrukcji użytkownika i pomocy Interfejsy Interfejsy użytkownika 10.2 Interfejsy sprzętowe Interfejsy programowe Interfejsy komunikacyjne Zastosowane standardy 6 Poufne <Nazwa firmy>, 2009 Strona 3

4 1. Wprowadzenie 1.1 Cel 1.2 Zakres [Sekcja wprowadzająca zawiera opis całego dokumentu SD. Zawiera wszelkie niezbędne informacje potrzebne do zrozumienia dokumentu przez użytkownika. Celem stworzenia dokumentu SD jest opisanie wymagań nie uwzględnionych w diagramie przypadków użycia, takich jak regulacje prawne odnośnie projektu, środowisko działania (system operacyjny, etc.) czy parametry jakościowe (niezawodność, wydajność, etc.).] [Niniejsza sekcja określa cel tworzenia SD..] [Sekcja ta pokrótce opisuje jakiego projektu SD dotyczy, co wpływa na kształt SD i na co sama SD ma wpływ.] 1.3 Pojęcia [Sekcja ta zawiera definicje pojęć czy skrótów niezbędnych do zrozumienia SD. Może być po prostu odniesieniem do Słownika.] 1.4 Odniesienia [Niniejsza sekcja zawiera informacje na temat wszelkich źródeł zewnętrznych, do których odniesienia znajdują się w SD. Opis źródła powinien zawierać jeśli to możliwe informacje o jego tytule, autorze, wersji, dacie publikacji oraz wydawnictwie.] 1.5 Streszczenie [Niniejsza sekcja opisuje resztę zawartości SD oraz sposób, w jaki jest ona zorganizowana.] 2. Założenia i zależności [Sekcja ta zawiera opis wszystkich projektów, technologii, podsystemów i komponentów na których bazuje lub od których zależny jest system..] 3. Używalność [Sekcja ta zawiera opis wszystkiego co wpływa na używalność projektu. Są to przede wszystkim: czas treningu użytkowników, czasy typowych zadań projektowych oraz wymagania, jakie stoją przed systemem, aby spełnił założone standardy, na przykład IBM s CUA czy Microsoft s GUI.] 3.1 <Pierwsze wymaganie używalności> 4. Niezawodność [Niniejsza sekcja zawiera opis warunków jakie system powinien spełniać pod względem niezawodności i potencjalnej awaryjności. Określa się tu przede wszystkim: Dostępność procent czasu, w którym system pracuje poprawnie i jest dostępny, typowe godziny użytkowania, zakres obsługi serwisowej, etc.. Poufne <Nazwa firmy>, 2009 Strona 4

5 Średni czas pomiędzy awariami zakładany średni czas jaki upływa pomiędzy krytycznymi awariami system mierzony w godzinach, dniach, miesiącach. Średni czas awarii ile czasu średnio potrzebne jest od wystąpienia awarii do naprawy systemu. Dokładność określenie dokładności na wyjściu systemu na podstawie obowiązujących standardów. Maksymalna ilość błędów określa się ją w ilości błędów na tysiąc linii kodu lub ilości błędów na funkcjonalność. Błędy nieznaczące, znaczące i krytyczne. Należy przede wszystkim określić co uznawane jest za błędy krytyczne.] 4.1 <Pierwsze wymaganie niezawodności> 5. Wydajność [Sekcja ta definiuje specyfikację wydajnościową systemu. Mile widziane są tu odniesienia do konkretnych przypadków użycia. Zdefiniowane są tu między innymi: Czas odpowiedzi systemu na zdarzenia średni i maksymalny. Przepustowość z reguły w transakcjach na sekundę. Pojemność maksymalna ilość klientów i transakcji, które system jest w stanie obsłużyć na raz. Tryby awaryjne w jaki sposób powinien zachowywać się system w razie uszkodzenia. Zużywane zasoby pamięć RAM, pojemność dysku twardego, karty sieciowe, etc. 5.1 <Pierwsze wymaganie wydajności> 6. Kompatybilność [Ta sekcja opisuje wszelkie wymagania wobec obowiązujących standardów jakie system musi spełniać. Są to na przykład konwencje nazewnictwa zmiennych i funkcji, użyte biblioteki, dostęp serwisowy, narzędzia serwisowe, standardy tworzenia kodu] 6.1 <Pierwsze wymaganie kompatybilności> 7. Ograniczenia projektowe [Sekcja ta opisuje wszelkie ograniczenia nałożone na projekt, których muszą trzymać się jego twórcy. Dotyczy ona przede wszystkim wybranych języków programowania, narzędzi programistycznych, architektury system, komponentów i bibliotek klas.] 7.1 <Pierwsze ograniczenie projektowe> 8. Bezpieczeństwo [Sekcja ta obejmuje opis zagrożeń systemu, przede wszystkim zagrożeń danych. Sprecyzowane w niej jest jakie dane mogą być zagrożone oraz co lub kto może spowodować zagrożenie danych,, a przede wszystkim podjęte środki ostrożności i obrony przed zagrożeniami (ograniczenia dostępu do systemu, kodowanie danych, etc.). Definiowane tu są również obiekty, które wymagają sprzętowej lub programowej ochrony.] Poufne <Nazwa firmy>, 2009 Strona 5

6 9. Wymagania dotyczące instrukcji użytkownika i pomocy [Sekcja ta zawiera opis wymagań stawianych przed dokumentacją dostępną dla użytkownika systemu, taką jak instrukcja obsługi, internetowa instrukcja obsługi, centrum pomocy, etc. ] 10. Interfejsy [Sekcja ta definiuje interfejsy, które mają być wspierane przez projekt. Definicja interfejsu powinna określać jego dokładną specyfikację, wliczając w nią protokoły, adresy, porty. Etc, tak, aby w fasie testów można było bez problemu zweryfikować zgodność. Generalnie są to interfejsy, których nie obejmuje zakres projektowy, ale które muszą być obsługiwane przez system.] 10.1 Interfejsy użytkownika [Sekcja ta pokrótce opisuje konieczne do implementacji interfejsy użytkownika i posiada odniesienie do dokumentu Projekt interfejsu.] 10.2 Interfejsy sprzętowe [Ta sekcja opisuje interfejsy sprzętowe, jakie system musi wspierać. W skład opisu wchodzi struktura, adres fizyczny, oczekiwane działanie, etc.] 10.3 Interfejsy programowe [Sekcja ta definiuje interfejsy programistyczne służące do połączeń z innymi częściami systemu. Mogą to być moduły pochodzące z innych aplikacji, gotowe moduły komercyjne.] 10.4 Interfejsy komunikacyjne [Sekcja ta zawiera opis interfejsów, za pomocą których system komunikować się będzie z innymi urządzeniami lub systemami. Są to na przykład połączenia zdalne, sieć lokalna, etc.] 11. Zastosowane standardy [Sekcja ta zawiera opis i odniesienia do standardów stosowanych przy tworzeniu projektu, dotyczy to standardów prawnych, przemysłowych, etc.] Poufne <Nazwa firmy>, 2009 Strona 6