Jak napisać instrukcję obsługi programu

Instrukcja użytkownika programu jest równie ważna, jak sam program.

Krok 1

Napisz schemat instrukcji. To da ci plan do naśladowania. Punkty uwzględnione w schemacie to proces instalacji, zastosowania programu, opisy menu, typowe zadania, funkcje zaawansowane i sekcja rozwiązywania problemów. Zawiera również podsekcje w projekcie dotyczące określonych zadań, takich jak tworzenie nowego pliku, zapisywanie i drukowanie plików.

Krok 2

Zawiera szczegółowy proces instalacji, w tym wymagania komputera. Zapewnia wymagania przed główną instalacją, dzięki czemu użytkownicy mogą przygotować swój komputer. Opisuje nawet najbardziej podstawowe kroki dla początkujących. Kroki te mogą polegać na "dwukrotnym kliknięciu pliku instalacyjnego" lub "włożeniu płyty CD do napędu CD ROM". Typowe etapy instalacji obejmują objaśnienie opcji instalacji, takich jak typowa instalacja, w przeciwieństwie do zaawansowanej instalacji, przejście użytkownika krok po kroku przez każdy ekran IGU (graficzny interfejs użytkownika), z którego są zlokalizowane, rejestracja program i wprowadź dowolny kod lub numery seryjne i jak uzyskać dostęp do programu po zainstalowaniu, aby sprawdzić, czy instalacja jest prawidłowa.

Krok 3

Zrób szczegółowy opis aplikacji programu. Obejmuje to, do czego jest potrzebny program i jak można z niego korzystać. Na przykład, jeśli program dotyczy księgowości, wyjaśnia, jak uprościć zwykłe zadania księgowe. Wyjaśnia, jakie są najważniejsze funkcje dla użytkownika końcowego. Dzięki temu użytkownik zorientuje się, jakie funkcje będą starali się najpierw nauczyć. Na przykład w programie do tworzenia muzyki powiedz użytkownikowi, ile utworów może on nagrać jednocześnie, wszystkie dźwięki i rytmy, które ma, oraz w jakich formatach może on zapisywać pliki. Zawiera krótki opis zaawansowanych funkcji, które czynią go innym programem niż inne na rynku. Na przykład Twój program może generować więcej raportów lub obsługiwać więcej typów plików niż jakikolwiek inny dostępny obecnie program.

Krok 4

Wyjaśnia, w jaki sposób poruszać się po menu. Wytłumacz każdy punkt dostępnych menu. Wszystko, co nie może być wyjaśnione w jednym lub dwóch zdaniach, powinno znaleźć się w sekcji "Typowe zadania" w podręczniku. Zadania te mogą obejmować zmianę czcionki i kolorów, drukowanie różnych formatów i typów plików oraz organizowanie plików i informacji.

Krok 5

Napisz osobną sekcję dla zaawansowanych funkcji i dodatkowych funkcji. Tutaj musisz przejść do szczegółów. Na przykład podręcznik użytkownika do programu Microsoft Excel zawierałby informacje o tworzeniu raportów, łączy i makr. Dodatkowe funkcje będą obejmować funkcje, na które użytkownik nie może czekać. Na przykład program do tworzenia muzyki może zapewnić wbudowany odtwarzacz muzyki. Poświęć trochę czasu na wyjaśnienie wszelkich dodatkowych problemów związanych z programem lub unikatowych aplikacji.

Krok 6

Obejmuje sugestie dotyczące rozwiązywania problemów. Wyjaśnia znaczenie każdego błędu, który użytkownik może znaleźć, jak rozwiązać problem i jak go uniknąć w przyszłości. Jest to również miejsce, w którym należy podać informacje kontaktowe i informacje o obsłudze klienta.