Rodzaje dokumentacji oprogramowania

Spisu treści:

Anonim

Jeśli kiedykolwiek widziałeś katalog komputerowy na dysku sieciowym w twojej firmie o nazwie "dokumenty programowe" lub "przewodniki oprogramowania", a następnie przejrzałeś dokumenty, które miałeś uprawnienia do przeglądania, prawdopodobnie zdałeś sobie sprawę, że liczba dokumentów i typów dokumentów dla oprogramowania jest liczny. Wydaje się również, że niektóre dokumenty umieszczone w jednej kategorii mają również zastosowanie do innych kategorii. Dokumenty oprogramowania są używane na każdym etapie typowego cyklu życia oprogramowania, więc jest to dobre miejsce do zbadania rodzaju tworzonych dokumentów.

Wniosek

Propozycja oprogramowania określa wymagania systemowe oprogramowania i określa cel oprogramowania oraz rozwiązywane problemy. Określa również szacowany czas potrzebny na wdrożenie projektu oprogramowania i inne czynniki wpływające na wniosek.

Studium wykonalności

Studium wykonalności zwykle odbywa się na początku projektu. Ten etap określa, czy zakład produkcyjny spełnia potrzeby biznesowe klienta. Wynik studium wykonalności decyduje, czy projekt będzie kontynuowany, czy nie.

Analiza wymagań

Analiza wymagań zapewnia środki do tłumaczenia wymagań biznesowych na zautomatyzowane rozwiązania programowe. Zewnętrzny konsultant lub kierownictwo firmy zazwyczaj wykonuje to zadanie. Wymagania przekładają wymagania biznesowe na rzeczywiste specyfikacje sprzętu, oprogramowania i komponentów.

Dokumenty projektowe

Dokumenty projektowe stanowią podstawę do rozpoczęcia rozwoju oprogramowania na poziomie technicznym. Jak sama nazwa wskazuje, wiele graficznych i tekstowych projektów baz danych, interfejsów, komunikacji, rozwoju stron internetowych i innych aspektów oprogramowania zostanie zaprojektowanych przed rozpoczęciem kodowania.

Kodowanie dokumentów

Dokumenty kodujące odnoszą się do rzeczywistego kodu źródłowego używanego do programowania oprogramowania. Kod może być napisany w dowolnej liczbie dostępnych języków komputerowych, w tym Java, C ++, PHP i setkach innych języków komputerowych w zależności od używanego systemu.

Testowanie dokumentów

Zespoły testujące i programiści tworzą dokumenty testowe na różnych etapach cyklu życia oprogramowania. Programiści tworzą dokumenty testów jednostkowych dla własnego kodu. Zespół testujący lub inne osoby niezwiązane bezpośrednio z tym kodem przeprowadzają testy integracyjne i testy wymagań biznesowych.

Przewodniki użytkownika i marketing

Podręczniki użytkownika zawierają instrukcje dotyczące działania nowego oprogramowania. Jeśli system jest duży i złożony, podręczniki użytkownika są zwykle poparte formalnymi szkoleniami dla personelu. Dokumenty marketingowe ilustrują korzyści nowego systemu oprogramowania dla potencjalnych klientów.

Licencje na oprogramowanie

Wydawanie licencji na oprogramowanie powoduje, że oprogramowanie jest legalne w odniesieniu do użytkownika końcowego. Użytkownicy korzystają z oprogramowania na warunkach licencji oprogramowania wydanej przez firmę tworzącą. Nie wszystkie oprogramowanie ma ścisłe warunki licencyjne, a dotyczy to w szczególności open source. Ogólnie rzecz biorąc, systemy oprogramowania mają pewną postać dokumentu licencyjnego określającego, w jaki sposób i gdzie można użyć oprogramowania.