Dokumentacja w inżynierii wymagań

A czy pamiętacie, co było w poprzednim artykule? Jeśli pamięć się ulotniła, to w gwoli przypomnienia, kilka informacji ;)

Co to jest:

• Artefakt - Produkt pracy, np. specyfikacja wymagań, model, prototyp.
• Poziom abstrakcji - Stopień szczegółowości, na którym opisywane są wymagania.
• Szczegółowość - Dokładność, z jaką opisywane są wymagania.

A gdy już powyższe informacje przypomniały CI o podstawowych definicjach to pamiętaj o tym:

• Wybieraj odpowiedni typ artefaktu: Istnieje wiele różnych typów artefaktów, np. specyfikacje wymagań, modele funkcjonalne, przypadki użycia, historie użytkownika. Wybór odpowiedniego typu zależy od celu, w jakim tworzony jest artefakt.
• Unikaj nadmiarowości: Nie powtarzaj tych samych informacji w różnych artefaktach. Zamiast tego odwołuj się do istniejących treści.
• Upewnij się, że nie ma niespójności: Wszystkie artefakty muszą być spójne ze sobą.
• Używaj terminów w sposób spójny: Zdefiniuj terminologię i stosuj ją konsekwentnie we wszystkich artefaktach.
• Odpowiednio strukturyzuj artefakty: Artefakty powinny być podzielone na logiczne sekcje i podsekcje, aby ułatwić ich czytanie i zrozumienie.

A gdy dojdziemy do planowania artefaktów, to zwróć uwagę na to, by:

• Określić, które wymagania i w jakim celu będą udokumentowane.
• Zdefiniować poziomy abstrakcji i szczegółowości dla każdego artefaktu.
• Określić, w jaki sposób wymagania będą przedstawione w poszczególnych artefaktach.

Typy artefaktów i ich zalety i wady:

• Artefakty oparte na języku naturalnym:
  • Zalety: łatwość tworzenia i rozumienia, elastyczność.
  • Wady: podatność na niejasności, niespójności i błędy interpretacyjne.
• Artefakty oparte na szablonach:
  • Zalety: przejrzystość, łatwość weryfikacji, spójność.
  • Wady: ograniczona elastyczność, ryzyko skupienia się na formie, a nie na treści.
• Artefakty oparte na modelach:
  • Zalety: łatwość zrozumienia zależności między wymaganiami, klarowność, precyzja.
  • Wady: złożoność, ograniczona ekspresywność dla niektórych typów wymagań.

Inżynier wymagań tworzy specyfikację wymagań dla nowego oprogramowania. Specyfikacja zawiera następujące artefakty:

• Opis kontekstu: Zawiera informacje o otoczeniu, w którym będzie działać oprogramowanie, oraz o interesariuszach.
• Model funkcjonalny: Opisuje funkcje oprogramowania.
• Przypadki użycia: Opisują typowe scenariusze użycia oprogramowania.
• Historie użytkownika: Opisują wymagania z perspektywy użytkownika.

Wszystkie artefakty są ze sobą spójne i tworzą kompletną specyfikację wymagań.

Dokumentacja jest ważną częścią inżynierii wymagań. Dobrze zaprojektowane i zarządzane artefakty mogą znacząco poprawić komunikację, zrozumienie i zarządzanie wymaganiami w projektach informatycznych.

Autor: Monika Kidyba