W jaki sposób radzimy sobie z plikami pomocy?

Question

Dodałem this question at SuperUser dla perspektywy użytkownika.

Tak więc tworzę aplikację w Delphi lub .NET, która będzie działać w systemie biurkowym. Kilka fajnych GUI z różnymi funkcjami i fajnymi funkcjami. Działa dobrze, testy mówią mi, że jest prawie bezbłędny i mam zamiar go wdrożyć ...

CZEKAJ! Potrzebuje pliku pomocy, aby użytkownicy mogli korzystać z kontekstowej pomocy aplikacji!

Czy nie? Czy w dzisiejszych czasach pliki pomocy są rzeczywiście wymaganiem dla aplikacji desktopowych? Czy naprawdę muszą być wrażliwe na kontekst, trzymając ręce użytkownika, aby powiedzieć im, że muszą wypełnić swój dzień urodzenia w tym polu "Dzień urodzenia"? A może pliki pomocy stają się nieco przestarzałe?

Jest to coś, nad czym się zastanawiam i jest to trochę subiektywne, więc zamiast tego zamierzam zadać coś innego, wszystkim, którzy rozwijają aplikacje na komputery: Czy nadal oferujecie pomocnicze kontekstowe pliki pomocy?

Tak, lub nie, proszę. Możesz dodać kilka subiektywnych tekstów, ale dla mnie ważna jest wiedza, czy nowi programiści wciąż dodają kontekstową pomoc do swoich aplikacji GUI.

(Btw, ja zostały przeniesione do non-kontekstowych plików PDF, które mogą być drukowane w instrukcji. Jest to o wiele łatwiejsze do utrzymania.)

Answer 1

Tak, robię.

Powód: Po prostu nie mogę oczekiwać, że użytkownik dowie się, jak działa program. Ok, opisywanie, co należy wpisać w polu "Dzień urodzenia" jest nieco ekstremalne, ale w systemie oprogramowania są zwykle bardziej skomplikowane rzeczy. Musiałem dziś napisać plik pomocy dla naszego systemu księgowania kosztów, opisując, w jaki sposób system określa cenę, która powinna być użyta do obliczeń. Nie sądzę, aby jakikolwiek użytkownik wiedział, jak skonfigurować system z tym plikiem pomocy.

Answer 2

tej chwili nie, ale nie piszę dużo aplikacji Windows. Większość z nich jest oparta na Internecie. Większość naszych aplikacji Windows jest dość mała i dobrze udokumentowana poza plikiem pomocy.

Ponadto, użytkownicy końcowi piszą dokumentację podczas procesu tworzenia, więc dokumentacja jest zrozumiała.

Jednakże, gdybym pisał dużą aplikację dla wielu użytkowników (a nie aplikację wewnętrzną), dołączałbym plik pomocy kontekstowej. Zrobiłem to w przeszłości w przypadku niektórych naszych większych aplikacji, a poza sytuacjami wewnętrznymi jest to bardzo pomocne.

Obecnie projektujemy naszą stronę internetową, aby mieć funkcję "potrzebnej pomocy", która jest zależna od kontekstu, a funkcja została dobrze przyjęta. Włączamy go do wszystkich naszych projektów internetowych, czy to na naszą stronę firmową, czy wewnętrzną.

Answer 3

Nigdy nie zapewniałem pomocy kontekstowej w aplikacji, ani też nie widziałem jej wystarczająco dobrze wdrożonej w jakiejkolwiek innej aplikacji, aby kiedykolwiek używać jej samodzielnie. Moim zdaniem wysiłek wymagany, aby to zrobić, znacznie przewyższa korzyści.

W sprawie ostatniej aplikacji, w której brałem udział w podejmowaniu tej decyzji, użyliśmy w aplikacji dymków z informacją, które wyświetlały dymek, gdy użytkownik unosił się nad każdą kontrolką. Dostarczyliśmy także konwencjonalny podręcznik, który zawiera głównie opisy z wieloma zrzutami ekranu krok po kroku.

Po pewnym czasie użytkownicy mieli dość balonów i wyłączyli je za pomocą pola wyboru, które dostarczyliśmy, ale wydawało się, że pomaga początkującym zacząć.

Answer 4

Podaję osobistą opinię, nie popartą żadnym innym faktem, który jest moim osobistym gustem.

Pisanie plików pomocy było przydatne w przeszłości, gdzie wszystko było nowe, a zasoby internetowe były rzadkie. Dzisiaj większość użytkowników komputerów uczy się poprzez bezpośrednie eksplorowanie. Pomoc kontekstowa w postaci etykietek narzędziowych jest świetna i silnie wspierana: daje wskazówki dotyczące tej odkrywczej nauki.

Co z dokumentacją pomocy zawierającą wiele linków do klikania? Cóż, wygląda na to, że jest świetny, ale rzadko go używam. W większości przypadków użytkownik może uzyskać odpowiedzi za pomocą odpowiedniego wyszukiwania google. Co więcej, ten rodzaj dokumentacji jest drogi. Nie może być napisane przez programistę. Musisz zatrudnić lub przydzielić konkretne osoby do tego, z technicznym pisaniem i jasnością jako odpowiednie umiejętności.

Gdybym miał zarządzać tą decyzją, dostarczałabym pełne dokumenty tylko dla tych cech, które są bardzo ezoteryczne i wyjątkowe (powiedziałbym, wyjątkowe) dla twojego wniosku. W każdym razie miałbym tendencję do korzystania z samouczka online zamiast kontekstowych plików pomocy. Ma to tę dodatkową zaletę, że dostarcza informacji o tym, jak trudna jest aplikacja i jakie są najbardziej pożądane punkty aktywne (poprzez ocenę haseł wyszukiwania i stron odsyłających do dokumentów online).

Answer 5

W niedawnej aplikacji nie zapewniamy pomocy kontekstowej. Miało to raczej techniczne przyczyny niż cokolwiek innego (plik pomocy jest zasadniczo wielojęzycznym plikiem docbooków, który teoretycznie obsługuje pomoc kontekstową, ale nie działała dobrze). Ma jedną stronę dla każdego okna/okna dialogowego w aplikacji, z wyjaśnionymi wszystkimi kontrolkami. Jednak każda kontrolka ma również dość obszerną etykietkę, która w większości przypadków eliminuje potrzebę dodatkowej pomocy. Każde okno dialogowe ma przycisk pomocy, aby wyświetlić stronę dialogową. Historycznie można było przechowywać tekst podpowiedzi w pliku pomocy, ale nie działa to w przypadku najnowszych systemów pomocy. I tak są przechowywane w zasobach.

Ale to nie jest aplikacja dla wszystkich. Ponieważ system sieciowy, który może być zarządzany za pomocą aplikacji, jest zagadnieniem złożonym sam w sobie, istnieje i tak specjalne szkolenie dla użytkowników, a aplikacja została zaprojektowana tak, że jeśli znacie system sieciowy, znacie również tę aplikację. Innymi słowy, model aplikacji tak dobrze komponuje się z modelem użytkownika, że ​​kompleksowe funkcje pomocy nie są potrzebne. To powinien być cel każdego rozwoju aplikacji.

Większość informacji w plikach pomocy dotyczących elementów sterujących nie jest tak naprawdę więcej niż to, co jest już w etykiecie narzędzi, ponieważ nikt nie potrzebuje więcej.

Office i Visual Studio rozwiązały problem raczej podobnie - naciśnięcie pomocy otwiera stronę pomocy dla całego okna dialogowego, a nie dla pojedynczego elementu sterującego.

Jeśli masz część dialogu, która jest tak skomplikowana, że ​​wymaga dodatkowego wyjaśnienia (i nie można jej przeprojektować w celu ułatwienia), możesz umieścić wyjaśnienie tuż obok kontrolki. Jest to używane w wielu aplikacjach w specjalnych przypadkach, aby przepływ pracy nie został przerwany, ponieważ użytkownik musi sprawdzić np. jak należy napisać konkretny tekst.

Answer 6

Mówienie jako użytkownik, a nie programista - tak, chcę plik pomocy kontekstowej.

Na przykład - obecnie analizuję kontrole innych podmiotów w celu uwzględnienia w nowym projekcie. Kontrolki, które mają dobrą pomoc kontekstową (tj.możesz wybrać właściwość w oknie właściwości lub słowo kluczowe w kodzie i nacisnąć F1, aby przejść od razu do tematu pomocy), są znacznie łatwiejsze do nauczenia się i użycia.

Answer 7

Wszystkie nasze aplikacje mają pomoc kontekstową w formie podpowiedzi (podobnie do wskazówek Office 2007) dla wszystkich krytycznych funkcji aplikacji.

Chociaż nie oferujemy tradycyjnego, pełnowartościowego pliku pomocy, zdecydowanie posiadamy bazę wiedzy, którą regularnie aktualizujemy. Jest to zbiór wszelkiej pomocy udzielanej klientom przez telefon, e-mail itp. We wszystkich kwestiach, odpowiednio skategoryzowanych i łatwych do wyszukania. Ostatecznie jest to najlepsza pomoc, która zawiera mniej lub bardziej to, czego klienci szukają, niż początkowo sądzą, że mogą potrzebować.

Podczas gdy kilku klientów niezmiennie kontaktuje się z nami tak szybko, jak tylko rzuca okiem na Bazę Wiedzy, nadal pomaga nam odkrywać nowe koło od nowa.

Answer 8

Dzięki podpowiedziom i ogólnie zwiększonej zdolności komputera w obsłudze niektóre aplikacje radzą sobie dobrze bez plików pomocy. Jednak niektóre aplikacje wymagają plików pomocy, tak samo jak w przypadku ogólnych informacji o tematach, takich jak użycie aplikacji. Na przykład w aplikacji do zdjęć możesz chcieć wyjaśnić kompresję jpeg i dołączyć kilka próbek do pliku pomocy, nawet jeśli działanie użytkownika jest oczywiste.

Wydaje mi się, że Microsoft przyczynia się do spadku pomocy kontekstowej, na dobre i na złe. Po pierwsze, systemy pomocy w Visual Studio są, delikatnie mówiąc, bolesne w użyciu. Po drugie, łatwość użytkowania systemu pomocy Visual Studio znacznie się obniżyła. Pomijam rant, ale wystarczy powiedzieć, że potrzeba więcej kliknięć i zwojów, aby uzyskać odpowiednie informacje w pomocy VS2008. To zwykle ustanawia niższy standard dla systemów pomocy w aplikacjach.

Answer 9

Brak pomocy? To jest dobre dla ludzi, którzy są technicznie skłonni i lubią bawić się z nowym oprogramowaniem. Ale jeśli twoje oprogramowanie będzie używane przez osoby, które nie znają się na technologiach, pomoc jest niezbędna. Weź przykład dat. Jeśli masz rynek międzynarodowy, lepiej opisz, czego potrzebuje program. Amerykanie stosują format MM/DD/RRRR, ale większość międzynarodowych użytkowników używa DD/MM/RRRR; musisz przeliterować, czego potrzebuje program.

Współpracowałem z wieloma programistami, którzy nie mieli absolutnie pojęcia o swoich użytkownikach końcowych io tym, jak działają. Na przykład CTO, który nalegał na swoją nową firmę, powinien pozbyć się drukowalnej dokumentacji, nie wiedząc, że ich klienci wydrukowali wszystkie pliki PDF i większość tematów pomocy za każdym razem, gdy była aktualizacja. Musisz znać swojego końcowego użytkownika i swój rynek. Niestety zbyt wielu programistów żyje w bańce, otoczonej przez innych programistów.

Czy deweloperzy powinni pisać pomoc? Prawdopodobnie nie. O ile nie możesz naprawdę myśleć jak o typowym użytkowniku końcowym, przygotuj notatki, ale pozwól twórcy techniki złamać informacje techniczne do poziomu, jakiego potrzebuje użytkownik końcowy.