Co to jest dokumentacja oprogramowania? (Ze zdjęciami)
Oprogramowanie odnosi się do procedur i programów opracowanych dla systemu komputerowego, które pozwalają na wykonywanie zadań lub inne interakcje z komputerem. Oprogramowanie może być dostarczone przez producenta jako komponent systemu lub utworzone jako oddzielne aplikacje przez producenta lub osoby trzecie. Dokumentacja to opis produktu i sposób jego użycia. Dokumentacja oprogramowania opisuje aplikacje i sposób ich używania.
Drukowana dokumentacja oprogramowania, zwana czasem podręcznikami oprogramowania, jest często konfigurowana jak książka, ze stroną tytułową, spisem treści, treścią i indeksem, i często zawierają niektóre typowe elementy. Pierwszym komponentem, którego większość użytkowników potrzebuje, jest przewodnik instalacji, a dla różnych systemów operacyjnych, na których działa oprogramowanie, w razie potrzeby podano osobne przewodniki. W instrukcji instalacji wymieniono specyfikacje wymagane do uruchomienia oprogramowania, w tym systemy operacyjne komputera, pamięć RAM, miejsce na dysku twardym, połączenie internetowe oraz wszelkie inne wymagania lub dodatki, takie jak urządzenia peryferyjne. Następnie instrukcje instalacji krok po kroku, które mogą pochodzić na przykład z dysku CD-ROM, DVD lub pliku do pobrania. Wszelkie nietypowe funkcje instalatora i objaśnienie niestandardowych opcji instalacji, takich jak alternatywne lokalizacje lub usprawnione instalacje, są ogólnie wyjaśnione.
„Przewodnik szybkiego startu” jest często następną częścią używanej drukowanej dokumentacji oprogramowania. Odnajdując miejsce, w którym kończy się przewodnik instalacji, przewodnik Szybki start pomaga użytkownikowi rozpocząć korzystanie z oprogramowania i jego podstawowych operacji. Ta sekcja może być rozmieszczona na różne sposoby, zależnie od konkretnego oprogramowania. Jedną z popularnych metod dla aplikacji zorientowanych na zadania jest wprowadzenie do projektu, w którym użytkownik uczy się podstawowej funkcjonalności oprogramowania podczas wypełniania kilku mini-lekcji.
Inne elementy, których można się spodziewać w drukowanej dokumentacji oprogramowania, obejmują kompletny przegląd funkcji, z naciskiem na funkcje nowe w najnowszej wersji; lista aktualizacji od poprzednich wersji, w tym prawdopodobnie naprawione błędy; informacje o tym, jak uzyskać wsparcie techniczne; wyjaśnienia komunikatów o błędach; oraz informacje dla zaawansowanych lub „zaawansowanych” użytkowników. Gry i inne aplikacje mogą zawierać w swoich dokumentach ściągawki lub wskazówki.
Wydrukowana dokumentacja oprogramowania nie jest jedyna. Po pierwsze, drukowana dokumentacja może być również dostępna online lub w formacie pdf. Dodatkowa dokumentacja może być również dostępna w formie podpowiedzi i ekranów pomocy w samej aplikacji, FAQ - list często zadawanych pytań wraz z odpowiedziami, artykułów do przeszukiwania, szkoleń internetowych, filmów i innych formatów.
Dokumentacja oprogramowania różni się pod względem jakości, szczególnie w przypadku instrukcji oprogramowania. Te dobre mogą być doskonałe, a te, które nie są dobrze wykonane, mogą pozostawiać użytkownikom wiele pytań. Są też użytkownicy, którzy nie zadają sobie trudu przeszukiwania dokumentacji przed zadawaniem pytań na forach producentów oprogramowania.