Często wypełnione żargonem, akronimami i wskazówkami, które wymagają do zrozumienia Ph.D, podręczniki użytkownika oprogramowania są czasami pisane z punktu widzenia programisty, a nie użytkownika. W rezultacie przewodnik może założyć, że poziom umiejętności czytelnika jest często nieprawidłowy. Pierwszym krokiem do napisania dobrej instrukcji obsługi jest uzyskanie jak najdalej od inżynierów rzeczywistego procesu pisania.
Twórca oprogramowania wie więcej niż ktokolwiek, co sprawia, że oprogramowanie działa, ale to nie znaczy, że programista powinien napisać przewodnik. Wręcz przeciwnie, jest to niekorzystna sytuacja. Ważniejsze niż dogłębne zrozumienie działania wewnętrznego oprogramowania to zrozumienie, kim będzie końcowy użytkownik, jaki jest jego poziom wykształcenia oraz w jaki sposób ten użytkownik końcowy będzie korzystał z oprogramowania. W większości przypadków użytkownicy końcowi nie muszą znać dokładniejszych punktów programowania i mechanizmów działania oprogramowania - po prostu muszą wiedzieć, jak z nich korzystać, aby ułatwić im pracę.
Testowanie użytkownika
Podręcznik użytkownika powinien być w dużej mierze zorientowany na zadania, a nie opisowy. Ponieważ podręcznik jest napisany, aby pomóc użytkownikom zrozumieć, jak wykonywać określone zadania, pisarz musi również rozumieć te zadania, w związku z czym przejście przez każdy dyskretny krok każdej funkcji jest absolutnie niezbędne. Pisarz nie musi koniecznie wiedzieć, w jaki sposób program został stworzony z punktu widzenia projektu lub rozwoju, ale niezbędne jest, aby mieć dobrą znajomość wszystkich jego funkcji. Wykonując każde zadanie, poświęć czas na zapisywanie każdego kroku, w tym kliknięć, menu rozwijanych i innych działań.
Proces wywiadu
Chociaż programista nie powinien pisać tego podręcznika, nadal będzie cennym źródłem informacji dla pisarza, a przed rozpoczęciem pisania zaplanować spotkanie inauguracyjne pomiędzy autorem, programistą i inżynierami, a potencjalnymi użytkownikami końcowymi, aby pomóc dzieło pisarza od początku. Wywiady z ekspertami i inżynierami przedmiotowymi powinny być rejestrowane, z transkrypcjami przygotowanymi do późniejszego wykorzystania.
Obrazowość
Instrukcja użytkownika nie powinna mieć zbyt dużego tekstu. Należy raczej włączyć liberalne wykorzystanie grafiki i klipów ekranowych. Opis działania jest znacznie wyraźniejszy dzięki kierunkom opartym na tekście, któremu towarzyszy klip ekranowy, który wyraźnie ilustruje ten kierunek. Uwzględnij widok przed i po wyświetleniu, aby pokazać, jak wygląda ekran przed wykonaniem każdego działania i co się stanie po wykonaniu działania. Proste narzędzie do przechwytywania ekranu, takie jak narzędzie do wycinania zawarte w systemie Microsoft Windows, działa dobrze w przypadku przechwytywania tych obrazów. Pamiętaj, aby numerować każdy obraz i dołączyć podpis, który krótko go opisuje. Wyśrodkuj go bezpośrednio pod akapitem, który po raz pierwszy wprowadza pojęcie przedstawione na obrazie.
Formatowanie
Dobra komunikacja w dokumencie technicznym wymaga planowania i starannego przestrzegania norm w całym przewodniku. Standardy zarówno prezentacji, języka, jak i nazewnictwa pomagają uniknąć zamieszania. Szablony są dostępne i mogą być dobrym punktem wyjścia dla jednolitości, chociaż można je z pewnością dostosować do każdej sytuacji. Używanie marginesu jednego cala z jedną kolumną najlepiej odpowiada potrzebie dodania grafiki; ustawienie dwukolumnowe może wydawać się zbyt zatłoczone i może sprawiać, że obrazy będą mylące.
Wersjonowanie i śledzenie
Bardziej niż jakikolwiek inny typ dokumentu, podręcznik użytkownika oprogramowania może przejść wiele iteracji, zanim zostanie ukończony i prawdopodobnie przejdzie proces recenzji przez wielu interesariuszy. Korzystanie z funkcji śledzenia zmian w Microsoft Word to łatwy sposób na śledzenie komentarzy i zmian poszczególnych osób. Tworzenie wielu wersji po każdym cyklu przeglądu, z których każdy ma inną nazwę, pomaga również procesowi i zapewnia, że wszyscy interesariusze są zadowoleni z końcowego wyniku.
