Dokumentacja funkcjonalna

Zasady ogólne

  1. Czytelność dla odbiorcy.
  2. Dopasowanie do odbiorcy.
  3. Odpowiednia nomenklatura.
  4. Zdania proste lub pojedynczo złożone.
  5. Obszerność.

Elementy podstawowe

  1. Strona tytułowa
  2. Cel
  3. Kontekst
  4. Opis funkcjonalny
  5. Przypadki użycia
  6. Słownik
 

Strona tytułowa

  1. Nazwa projektu
  2. Autor
  3. Wersja
  4. Daty, autorzy, opis zmiany

Cel

  1. "Celem raportu jest określenie najpopularniejszych szkoleń. Popularność szkoleń jest tożsama z ilością jego uruchomień."
  2. "Celem raportu jest określenie najpopularniejszych szkoleń."
  3. "Celem raportu jest wyeksportowanie nazwy szkolenia, daty utworzenia oraz liczby wejść na nie."

Cel

  1. "Celem raportu jest określenie najpopularniejszych szkoleń. Popularność szkoleń jest tożsama z ilością jego uruchomień." - Nadmiarowość.
  2. "Celem raportu jest określenie najpopularniejszych szkoleń."
  3. "Celem raportu jest wyeksportowanie nazwy szkolenia, daty utworzenia oraz liczby wejść na nie." - Cel nie jest jasny dla odbiorcy.

Kontekst

  1. "Platforma będzie korzystała z bazy danych znajdującej się pod adresem x.com."
  2. "Platforma będzie korzystała z bazy danych znajdującej się pod adresem x.com. W tym celu zostanie zbudowany tunel VPN do infrastruktury klienta."
  3. "Platforma będzie korzystała z SSO znajdującego się pod adresem x.com. Łączność z bazą danych można uzyskać dzięki tunelowi VPN."

Kontekst

  1. "Platforma będzie korzystała z bazy danych znajdującej się pod adresem x.com."
  2. "Platforma będzie korzystała z bazy danych znajdującej się pod adresem x.com. W tym celu zostanie zbudowany tunel VPN do infrastruktury klienta."
  3. "Platforma będzie korzystała z SSO znajdującego się pod adresem x.com. Łączność z bazą danych można uzyskać dzięki tunelowi VPN."

Sposób realizacji

  1. "W celu zapewnienia synchronizacji z zewnętrzną bazą, Gromar zbuduje mechanizm importu danych. Będzie on polegał na dodawaniu nowych danych z zewnętrznej bazy. Import będzie miał miejsce co godzinę. W celu ustanowienia połączenia pomiędzy serwerami zostanie zestawione połączenie VPN."
  2. "W celu zapewnienia synchronizacji z zewnętrzną bazą, Gromar zbuduje mechanizm importu danych. Będzie on miał miejsce co godzinę."
  3. "W celu zapewnienia synchronizacji z zewnętrzną bazą, Gromar zbuduje mechanizm importu danych. Będzie on polegał na dodawaniu nowych danych z zewnętrznej bazy. Import będzie miał miejsce co godzinę. W celu ustanowienia połączenia pomiędzy serwerami zostanie zestawione połączenie VPN. Realizacja nastąpi nie później jak do ostatniego dnia września 2013."

Sposób realizacji

  1. "W celu zapewnienia synchronizacji z zewnętrzną bazą, Gromar zbuduje mechanizm importu danych. Będzie on polegał na dodawaniu nowych danych z zewnętrznej bazy. Import będzie miał miejsce co godzinę. W celu ustanowienia połączenia pomiędzy serwerami zostanie zestawione połączenie VPN."
  2. "W celu zapewnienia synchronizacji z zewnętrzną bazą, Gromar zbuduje mechanizm importu danych. Będzie on miał miejsce co godzinę." - Niedomiar.
  3. "W celu zapewnienia synchronizacji z zewnętrzną bazą, Gromar zbuduje mechanizm importu danych. Będzie on polegał na dodawaniu nowych danych z zewnętrznej bazy. Import będzie miał miejsce co godzinę. W celu ustanowienia połączenia pomiędzy serwerami zostanie zestawione połączenie VPN. Realizacja nastąpi nie później jak do ostatniego dnia września 2013."

Przypadki użycia

  1. Nazwa kodowa.
  2. Aktorzy (role w systemie, ale nie zawsze).
  3. Sposób wywołania.
  4. Scenariusz pozytywny.
  5. Scenariusz(e) negatywny(e).

Przypadki użycia

  1. Kod: SYNC_01
  2. Aktorzy: System
  3. Wywołanie: Program CRON o godzinie 03:30 uruchamia skrypt synchronizujący.
  4. Pozytywny:
    System tworzy połączenie VPN.
    System pobiera i odczytuje plik z adresu x.com/eksport.csv.
    System dla każdego wiersza danych sprawdza istnienie konta w systemie na podstawie loginu.
    System tworzy konta o dotychczas niewystępującym loginie.
  5. Negatywny: 
    System tworzy połączenie VPN.
    System nie moze pobrać pliku x.com/eksport.csv.

Uwagi

  1. Najpierw specyfikacja.
  2. Tabelka modyfikacji, po co?
  3. Gromar, to brzmi dumnie.
  4. Piszmy dużo.
  5. Odbiorca nasz Pan.

PRINCE2

By Piotr Woszczyk

Made with Slides.com

PRINCE2

  • 37

More from Piotr Woszczyk