Co to jest dokument dotyczący projektu oprogramowania?

Dokument projektowy oprogramowania określa specyfikacje oprogramowania, które stanowią mapę drogową dla programistów. Jest produkowany na wczesnym etapie tworzenia oprogramowania i może być modyfikowany w zależności od zmieniających się okoliczności i potrzeb. Ta dokumentacja jest przeznaczona do użytku wewnętrznego i zwykle nie jest rozpowszechniana poza zespołem projektowym i biurami klienta. W niektórych przypadkach fragmenty mogą być publikowane w ramach badań lub komunikacji z osobami spoza firmy.

Komponenty dokumentu projektu oprogramowania określają, co produkt ma zrobić i jak powinien to zrobić. Obejmuje to podstawową architekturę programu wraz ze wszystkimi funkcjami, które programiści muszą uwzględnić w gotowym produkcie. Dokumentacja może omawiać interfejs graficzny i sposób interakcji użytkowników z programem, aby zaoferować programiście wskazówki podczas przechodzenia przez kolejne etapy programowania.

W tworzenie dokumentu projektu oprogramowania może być zaangażowanych wielu pracowników. Omawiają różne potrzeby i obawy, aby upewnić się, że dokument jest kompletny i że dokładnie odzwierciedla potrzeby klientów. Ich celem jest stworzenie jednego jednolitego przewodnika dla członków zespołu do użycia. Zapewnia to spójność procesu programowania, ponieważ wszyscy używają tego samego dokumentu referencyjnego podczas projektowania i wdrażania funkcji.

Oprócz dyskusji na temat tego, jak powinno działać oprogramowanie, dokument projektu oprogramowania może wyraźnie obejmować odbiorców docelowych. Na przykład firma pracująca nad oprogramowaniem do sterowania urządzeniem naukowym może założyć, że każdy użytkownik jest naukowcem lub technikiem zaznajomionym z maszyną. Oznacza to, że oprogramowanie nie musi zawierać uproszczeń języka technicznego ani dyskusji na temat działania mechanizmów kontrolnych, ponieważ użytkownik powinien to już wiedzieć.

Natomiast oprogramowanie przeznaczone do przetwarzania tekstu może wymagać dokumentacji i przewodnika dla użytkowników, którzy nie znają się na przetwarzaniu tekstu i komputerach. Może być przydatny natychmiast po wyjęciu z pudełka dla kogoś z doświadczeniem, ale może mieć moduły, z których mogą korzystać użytkownicy, którzy chcą dowiedzieć się o funkcjach, uzyskać samouczki lub szukać pomocy w określonym zadaniu. Parametry określone w dokumencie projektu oprogramowania dla bardziej technicznych projektów mogą zalecić pominięcie dokumentacji i wskazówek dla użytkownika na temat argumentu, że użytkownicy oprogramowania tego nie potrzebują, co oznacza, że ​​nie ma powodu, aby inwestować czas i energię w rozwój to.