Chociaż często ignorowane przez wielu użytkowników komputerów, pliki pomocy zawierają kluczowe informacje na temat korzystania z aplikacji, z którą są skojarzone. Klikając „Pomoc”, użytkownik może uzyskać przegląd funkcji programu, opis ekranu, na który patrzy, instrukcje, jak używać programu do wykonania danego zadania lub przeczytać listę najczęściej zadawanych pytań na temat program i ich odpowiedzi. Pisanie pliku pomocy wymaga zarówno umiejętności pracy z aplikacjami, jak i wyjaśniania rzeczy w zrozumiały dla użytkowników sposób.
Kroki
Krok 1. Uzyskaj kopię oprogramowania, które chcesz udokumentować
Jeśli to możliwe, powinieneś również otrzymać kopię pisemnej specyfikacji programu, chociaż nie wszyscy programiści z nimi pracują. W niektórych przypadkach programista odbiega od specyfikacji ze względu na krótki czas rozwoju lub niemożność zakodowania określonej funkcji.
Krok 2. Uzyskaj narzędzie do tworzenia pomocy
Chociaż możliwe jest ręczne utworzenie pliku pomocy przy użyciu pliku w formacie sformatowanego tekstu (.rtf), większość autorów plików pomocy używa aplikacji do pisania swoich plików pomocy, takich jak RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare lub HelpLogix. Większość narzędzi do tworzenia pomocy obejmuje edytor tekstu lub pracę z programem do edycji tekstu, takim jak Microsoft Word i zapewnia interfejs użytkownika, który pozwala autorowi pomocy zobaczyć, jak będzie wyglądał plik pomocy podczas pisania go podczas pisania kodu komputerowego za kulisami aby plik pomocy działał. Niektóre narzędzia do tworzenia pomocy zawierają również edytory graficzne do tworzenia zrzutów ekranu, które można umieścić w pliku pomocy.
Istnieje kilka formatów plików pomocy: Najpopularniejszym jest Pomoc HTML, używana przez aplikacje działające w systemie Windows. (Starszy format, WinHelp, nie jest już obsługiwany.) Zarówno Apple, jak i Unix mają swoje własne formaty, podobnie jak Sun Microsystems z JavaHelp. Aplikacje przeznaczone do działania w kilku systemach operacyjnych mogą korzystać z wieloplatformowego systemu pomocy działającego w przeglądarce internetowej użytkownika. Niezależnie od tego, jakiego narzędzia do tworzenia pomocy używasz, powinno obsługiwać formaty pomocy, w których zamierzasz tworzyć pliki pomocy
Krok 3. Utwórz plik projektu pomocy
Twoje narzędzie do tworzenia pomocy utworzy dla Ciebie plik projektu pomocy na podstawie podanej nazwy pliku i innych informacji. Główny plik projektu zawiera informacje o innych plikach, w tym plik zawartości, plik indeksu, jeden lub więcej plików graficznych i inne pliki.
- Plik zawartości zawiera tekst w pliku pomocy, który wyjaśnia, jak działa dokumentowana aplikacja. Tekst jest zwykle podzielony na tematy, które dotyczą konkretnego ekranu, funkcji lub procedury.
- Plik indeksu to lista tematów pliku pomocy. Służy do tworzenia spisu treści, który użytkownicy mogą wykorzystać do wyboru tematu do wyświetlenia, a także przeszukiwalnego indeksu w pliku pomocy.
- Pliki obrazów to pliki graficzne ekranów programu lub części tych ekranów wyświetlane w pliku pomocy, aby zwiększyć zdolność użytkowników do zrozumienia, do czego odnosi się tekst pliku pomocy.
Krok 4. Dostosuj rozmiar okna pomocy
O ile nie piszesz pliku pomocy, który ma się pojawiać w przeglądarce internetowej użytkownika, plik pomocy pojawi się w osobnym oknie. Twoje narzędzie do tworzenia pomocy pozwoli Ci dostosować poziome i pionowe wymiary okna do rozmiaru, który pozwoli użytkownikowi końcowemu przeczytać plik pomocy bez przeszkadzania samej aplikacji. Główne okno pomocy często ma format trójpanelowy, ze spisem treści po lewej stronie i wybranym tematem po prawej.
Pliki pomocy mogą również zawierać, oprócz okna głównego, okna dodatkowe, które szczegółowo opisują konkretną funkcję i automatycznie dostosowują wyskakujące okienka z krótkimi opisami funkcji. Pliki pomocy mogą również zawierać osadzony tekst, który pojawia się tylko po kliknięciu podświetlonego tekstu lub kliknięciu przycisku
Krok 5. Napisz tematy pomocy
Aby to zrobić, musisz przejrzeć specyfikacje lub sam program, aby utworzyć tematy dokumentujące ekrany i funkcje programu. Po utworzeniu każdego tematu narzędzie do tworzenia pomocy doda go do spisu treści i indeksu pliku pomocy.
- Chociaż możesz budować spis treści na bieżąco, warto mieć jakiś plan, jak go zorganizować. Możesz organizować spis treści wokół ekranów programu, jego funkcji, sposobów korzystania z niego lub ich kombinacji.
- Podczas pisania tematów rozważ inne informacje w pliku pomocy, do których użytkownicy będą chcieli mieć szybki dostęp. W tekście pliku pomocy można tworzyć przeskoki lub hiperłącza, które łączą się z tematami zawierającymi te informacje.
Krok 6. W razie potrzeby dołącz zrzuty ekranu
Wiele funkcji programu najlepiej wyjaśnia kombinacją tekstu i grafiki. Możesz tworzyć zrzuty ekranu za pomocą aplikacji dostarczonej z narzędziem do tworzenia pomocy lub oddzielnej aplikacji, takiej jak Microsoft Paint, Paint Shop Pro lub SnagIt.
- Tekst i zrzuty ekranu powinny być ułożone razem w temacie, tak aby użytkownicy mogli zobaczyć zrzut ekranu i jego tekst pomocniczy bez zbędnego przewijania. W wielu przypadkach będziesz chciał pokazać część ekranu programu zamiast całego ekranu lub pokazać zrzut ekranu w mniejszym rozmiarze niż oryginał. Twoja aplikacja do wykonywania zrzutów ekranu powinna umożliwiać zmianę rozmiaru zrzutu ekranu bez rozmycia lub utraty szczegółów.
- Jeśli przewidujesz zmiany w interfejsie użytkownika między testową a ostateczną wersją programu, możesz wstrzymać się z tworzeniem zrzutów ekranu, dopóki nie będziesz mieć ostatecznej wersji programu do pracy.
Krok 7. Utwórz plik mapy, jeśli jest potrzebny
Niektóre programy zawierają przyciski „Pomoc”, które użytkownik może kliknąć i wyświetlić temat w pliku pomocy, który szczegółowo opisuje działanie tego ekranu. Wyświetlanie tematu w ten sposób nazywa się pomocą kontekstową i wymaga utworzenia pliku mapy, aby programista połączył przycisk „Pomoc” z konkretnym tematem w pliku pomocy. Twoje narzędzie do tworzenia pomocy może je dla Ciebie utworzyć lub programista może je zakodować i przekazać Ci do dołączenia do pliku pomocy.
Krok 8. Skompiluj plik pomocy
Kompilacja tworzy rzeczywisty plik pomocy, który zostanie dołączony do programu. W przypadku większości formatów pomocy zostaną uwzględnione wszystkie pliki składowe, które zostały utworzone podczas tworzenia pliku pomocy, chociaż niektóre nieskompilowane formaty pomocy wymagają również dołączenia do programu indywidualnych plików tematów pomocy.
Krok 9. Przetestuj plik pomocy
Po skompilowaniu pliku pomocy należy go przetestować, aby upewnić się, że wszystkie hiperłącza łączą się z tematami, do których powinny, a wszystkie grafiki wyświetlają się poprawnie. Plik pomocy należy również przetestować, aby upewnić się, że treść jest dokładna i odpowiednia dla użytkowników oraz ma spójny format. Będziesz chciał samodzielnie przejrzeć plik pomocy, a także poprosić osoby testujące aplikację.
W przypadku większych projektów plików pomocy kompilacja i testowanie są procesami ciągłymi. Będziesz chciał skompilować plik pomocy i kilka razy sprawdzić swoją pracę przed utworzeniem ostatecznej wersji
Krok 10. Przekaż programiście plik pomocy, który ma dołączyć do programu
W zależności od charakteru projektu i formatu pliku pomocy może być konieczne dostarczenie programiście kilku plików, w tym pliku mapy, jeśli istnieją tematy zależne od kontekstu.
