Co to jest dokumentacja oprogramowania?

Oprogramowanie Odnosi się do procedur i programów opracowanych dla systemu komputerowego, które umożliwiają użycie zadań lub w inny sposób interakcję z komputerem.Oprogramowanie może być dostarczone przez producenta jako komponent systemowy lub utworzony jako osobne zastosowania przez producenta lub strony trzecie. Dokumentacja jest opisem produktu i sposobu go używania.Dokumentacja oprogramowania opisuje aplikacje i sposób ich używania.

Dokumentacja oprogramowania, czasem określana jako instrukcje oprogramowania, są często konfigurowane jak książka, ze stroną tytułową, spisem treści, ciała i indeksu, i często mają oneNiektóre typowe komponenty.Pierwszym komponentem, w którym większość użytkowników potrzebuje, jest instalacja instalacyjna i w razie potrzeby podano osobne przewodniki dla różnych systemów operacyjnych.Podręcznik instalacyjny zawiera listę specyfikacji, które są wymagane do uruchomienia oprogramowania, w tym system (systemy) komputera, RAM, miejsce na dysku twardym, połączenie internetowe oraz wszelkie inne wymagania lub dodatki, takie jak peryferyjne.Następnie następuje instrukcje dotyczące instalacji krok po kroku, które mogą pochodzić na przykład z CD-ROM, DVD lub pobierania.Wszelkie nietypowe funkcje instalatora i wyjaśnienie niestandardowych opcji instalacji, takie jak alternatywne lokalizacje lub usprawnione instalacje, są ogólnie wyjaśnione.

Przewodnik „Szybkiego początkowego” jest często kolejną częścią używanej dokumentacji oprogramowania.Wybierając miejsce, w którym opuszcza przewodnik instalacyjny, podręcznik Quick Start pomaga użytkownikowi zacząć od oprogramowania i jego podstawowych operacji.Ta sekcja może być ułożona na różne sposoby, ponieważ odpowiada konkretnemu oprogramowaniu.Jedną popularną metodą aplikacji zorientowanych na zadania jest wprowadzenie oparte na projekcie, w którym użytkownik uczy się podstawowej funkcjonalności oprogramowania podczas wypełniania niektórych mini-bezwzględnych.

Inne elementy, których można się spodziewać w wydrukowanej dokumentacji oprogramowania, obejmują pełne wycofanie funkcji, z naciskiem na funkcje nowe w najnowszej wersji;Lista aktualizacji od poprzednich wersji, być może zawierająca naprawy błędów;informacje o tym, jak uzyskać wsparcie techniczne;Objaśnienia komunikatów o błędach;oraz informacje dla użytkowników zaawansowanych lub „zasilania”.Gry i inne aplikacje mogą obejmować kary lub wskazówki w ich dokumentacji.

Dokumentacja oprogramowania drukowana nie jest jedynym rodzajem.Przede wszystkim drukowana dokumentacja może być również dostępna online lub jako pdf.Dodatkowa dokumentacja może być również dostępna w postaci wskazówek narzędzi i ekranów pomocy w samej aplikacji, FAQ i mdash;Listy często zadawanych pytań wraz z odpowiedziami, artykułami do wyszukiwania, szkolenia internetowego, filmów i innych formatów.

Dokumentacja oprogramowania różni się nieco pod względem jakości, a szczególnie dotyczy to podręczników oprogramowania.Dobre mogą być doskonałe, a te, które nie są dobrze wykonane, mogą pozostawić użytkownikom wiele pytań.Są też użytkownicy, którzy nie będą zawracać sobie głowy przeszukaniem dokumentacji przed zadaniem pytań na forach producenta oprogramowania.