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 korzystania z niego. Dokumentacja oprogramowania opisuje aplikacje i sposób ich używania.
Dokumentowana dokumentacja oprogramowania, czasem określana jako instrukcje oprogramowania, są często konfigurowane jak książka, ze stroną tytułową, spisu treści, ciała i indeksu, i często mają one 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 instalacji zawiera listę specyfikacji wymaganych do uruchomienia oprogramowania, w tym system (systemy) komputerowego, pamięć RAM, miejsce na dysku twardym, internetowe połączenien 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 startowy” 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óre można by wydaćT, aby znaleźć w drukowanej dokumentacji oprogramowania, obejmuje pełne zwolnienie 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.
Dokumentowanie oprogramowania 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 formie wskazówek narzędzi i ekranów pomocy w samej aplikacji, FAQ - 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, podczas gdyES, 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.