Źle skonstruowane FAQ nie składa się z pytań, które faktycznie użytkownicy tworzą, a z pytań które autor przygotuje. Prawdopodobnie widziałeś już coś podobnego:
Q: Jak użyć Glorbosoft XYZ do zwiększenia produktywności mojego zespołu?
A: Wielu naszych klientów chce wiedzieć w jaki sposób mogą zmaksymalizować produktywność dzięki naszej opatentowanej technologi. Odpowiedź jest prosta. Po pierwsze, należy kliknąć na
Plikmenu, przejść doZwiększ Produktywność, następnie…
Problem z takimi pytaniami i odpowiedziami jest taki, że nie są one prawidłowo zadane. Nikt nigdy nie zapytał helpdesku „W jaki sposób możemy zmaksymalizować produktywność?” Ludzie zadają sprecyzowane pytania i oczekują konkretnych odpowiedzi na nie. Dla przykładu „Jak możemy zmodyfikować system powiadomień by otrzymać powiadomienie dwa dni wcześniej zamiast jeden dzień przed?” itd. Oczywiście prościej jest wymyślić pytania niż je zebrać od użytkowników. Sporządzenie FAQ z prawdziwego zdarzenia powinno wiązać się z monitorowaniem środowiska naturalnego i zbierania pojawiających się pytań. Bez owijania w bawełnę – przekazujemy tylko to co jest wartościowe i potrzebne.
To co mi się podoba to to, że ta książka wychodzi poza schemat powyżej przytoczony. Jest to wynikiem bezpośrednich obserwacji Collins-Sussman, ludzi zadających wciąż podobne proste pytania przez listę mailingową. Czy rozgałęzienia i tagi działają w ten sam sposób jak w innych systemach kontroli wersji? Jak mogę się dowiedzieć kto wprowadził ostatnią zmianę?
Sfrustrowany Ben widząc powtarzające się pytania dzień w dzień, zaczął myśleć o podręczniku dla Subversion . Podręcznik obejmował wszystkie podstawy i z czasem był rozbudowywany, a późniejsza wersja została opublikowana przez wydawnictwo O'Reilly
Trzech współautorów miało niecodzienną możliwość współtworzenia książki. Mieli za zadanie stworzyć książkę od góry do dołu, zaczynając od spisu treści i wstępnego projektu. Równocześnie trwała ekspansja użytkowników oprogramowania Subversion co powodowało duży napływ poprawek, usprawnień zarówno do kodu źródłowego jak i do tworzonej dokumentacji.
Przez cały czas tworzenia tego podręcznika, Ben, Mike i Brian polowali na listach mailingowych, czatach za problemami, które sygnalizowane są przez użytkowników w realnych sytuacjach. Tak zdobyte doświadczenie pomogło w napisaniu bardzo dobrego podręcznika dla Subversion. Podręcznik jest miksem pomiędzy instrukcją obsługi a często zadawanymi pytaniami. Z początku może się wydawać inaczej – prosta książka opisująca oprogramowanie. Jednak w przypadku gdy będziemy powracać do książki, zauważymy dopiero jej potęgę i łatwość znalezienia rozwiązania na nurtujący nas problem.
Oczywiście nikt nie może obiecać, że ta książka udzieli odpowiedzi na każde pytanie dotyczące Subversion. Często może się zdarzyć, że odpowiedzi nie uzyskasz. Dlatego możesz zawsze napisać na email <users@subversion.tigris.org> i przedstawić swój problem. Autorzy cały czas monitorują swoją skrzynkę. Pamiętaj, społeczność wokół tego projektu cieszy się kiedy może komuś pomóc – ponieważ to przyczynia się do rozwoju projektu i wyznaczania jego następnych celów. Z Subversion, podobnie jak w przypadku wszystkich innych aktywnych projektów wolnego oprogramowania, nie jesteś sam.
Niech ta książka będzie dla was pierwszą pomocą i drogowskazem.