Jak utrzymac porządek w dokumentach?

Jak utrzymac porządek w dokumentach?

Przy pracy z dużymi dokumentami (a nie oszukujemy się, każda specyfikacja wymagań ma co najmniej kilkanaście stron) istotną kwestią jest umiejętność utrzymywania spójności całego dokumentu. Na początku, gdy regularnie pracujemy nad dokumentem to nie stanowi to dla nas problemu, jednak z begiem czasu, gdy edytujemy tekst od czasu do czasu, a tym bardziej gdy edycji dokonuje kilka osób to utrzymanie porządku i spójności staje się nie lada wyzwaniem.

Co z tym zrobić?

Jedym z prostszych sposobów na utrzymanie chociaż częściowego porządku jest nadawanie unikalnych identyfikatorów wszystkim pojedynczym wymaganiom, regułom biznesowym, procesom, diagramom, tabelom, etc. Dzięki identyfikatorom w łatwy sposób będzemy mogli odwoływać się do tych elementów w innych częściach naszego SRSa.

Nie podmieniaj!

Oczywiście w trakcie naszych prac klient zapewne kilka razu zmieni zdanie i będziemy zmieniać różne wymagania, a nawet niektóre będziemy chcieli usunąć. Co wtedy z identyfikatorami? Po pierwsze identyfikatory pozwalają nam w prosty sposób odnaleźć wszystkie referencje do danego elementu, w ten sposób możemy sprawdzić spójność poszczególnych części dokumentu. Po drugie należy pamiętać, aby nigdy nie używać ponownie wcześniej użytych identyfikatorów! Czyli jeśli nadajesz identyfikatory w określonej kolejności, to nawet jeśli usuniesz jakieś wymaganie to nigdy żadnemu innemu wymaganiu w tym dokumencie nie nadawaj identyfikatora usuniętego elementu, np. załóżmy, że Twoje wymagania mają identyfikatory Wym1, Wym2, Wym3, Wym4, w pewnym momencie chcesz usunąć wymaganie oznaczone jako Wym2, to już nigdy później w ramach tego samego projektu nie nadawaj identyfikatora Wym2 żadnemu innemu elementowi Twojej specyfikacji,

Podpowiedzi

Pamiętaj też, żeby tworzyć identyfikatory, które będą w jakiś sposób podpowiadały jaki element oznaczają, np. dla rysunków niech Twoje identyfikatory mają formę Rys1, Rys2, etc. Jeśli dzielisz swoją specyfikację na części (np. moduły funkcjonalne) to może warto do identyfikatora wymagania dodać identyfikator danej części, np. Mod1Rys4, Mod3Rys4. Jeśli chcesz zapewnić sobie unikalność identyfikatorów w ramach wszystkich swoich projektów to można też dodać do wszystkich identyfikatorów oznaczenie projektu.

Dodaj komentarz