Wiele organizacji produkuje własne narzędzia lub modyfikuje komercyjnie dostępne narzędzia na własny użytek. Narzędzia te powinny zostać udokumentowane, aby były przydatne dla innych osób w organizacji.
Jeśli ta dokumentacja nie zostanie utworzona lub jest źle napisana, kosztuje dwa razy:
* Pierwszym kosztem (przypisanym do każdego złego dokumentu użytkownika) jest koszt odpowiedzi na pytania użytkowników (wsparcie techniczne).
* Drugi koszt wynika z straconego czasu pracowników, którzy próbują zrozumieć zły dokument użytkownika.
Ludzie żyjący w maleńkich przestrzeniach - Hongkong: Najruchliwsze miasta świata | BBC Two
Koszty psychologiczne mają również wpływ na użytkownika zewnętrznego i wewnętrznego.
PIERWSZY KOSZT: POMOC TECHNICZNA
Jest to koszt, który ponosisz za każdym razem, gdy produkujesz słabe (lub nie) dokumenty użytkownika. Powstaje dla każdego Użytkownika, gdy potrzebuje wsparcia technicznego. W przypadku użytkowników zewnętrznych kosztem są pracownicy działu pomocy technicznej, bezpłatne linie telefoniczne itp.
Dla użytkowników wewnętrznych kosztem jest czas spędzony przez programistę lub modyfikator narzędzia, aby odpowiedzieć na pytania swojego kolegi pracownika. Jest to kosztowny koszt pomocy technicznej ... te osoby są zwykle opłacane bardziej niż pracownicy działu pomocy technicznej. Tak więc ten pierwszy koszt jest jeszcze większy w przypadku słabej wewnętrznej dokumentacji, niż w przypadku tandetnej dokumentacji udostępnionej publicznie.
DRUGI KOSZT: CZAS I ŹRÓDŁA UŻYTKOWNIKÓW
W przypadku Użytkowników spoza firmy drugim kosztem zajmują się sami Użytkownicy lub ich pracodawcy. Ci zdezorientowani użytkownicy poświęcają czas swojej firmie: czas stracony na próbę uruchomienia produktu i czas poświęcony na obsługę techniczną.
Dla Twoich własnych użytkowników ten koszt ponosi twoja firma. To twój pracownik - na twój czas - marnuje zasoby twojej firmy próbując użyć tajemnego produktu lub dokumentu. Tutaj twoja niedostateczna dokumentacja wewnętrzna kosztuje dwa razy.
KOSZTY PSYCHOLOGICZNE WPŁYWAJĄ NA WSZYSTKIE CZYTELNIKI
Oprócz tych kosztów czasowych i pieniężnych, istnieją również koszty psychologiczne spowodowane przez słabą dokumentację użytkownika.
W przypadku sfrustrowanych użytkowników spoza firmy, zła dokumentacja powoduje negatywne postrzeganie firmy i jej produktów. Może to spowodować utratę firmy.
Dla użytkowników wewnątrz firmy koszt psychologiczny to obniżone morale pracowników, o czym świadczą następujące możliwe stwierdzenia:
* Nasza firma wyprodukowała te śmieci?
* Ci ludzie nie są ostrzy, jak myślałem.
* Jeśli inni pracownicy mogą produkować te zagmatwane rzeczy, mogę pracować na tym samym poziomie.
W związku z tym chory na zewnątrz firmy może kosztować przyszłych sprzedaży; chory wewnątrz twojej firmy może kosztować niższe morale pracowników.
ROZWIĄZANIE: NIEFORMALNE RECENZJE
Gdy ktoś napisze dokument użytkownika dla własnego narzędzia, dokument ten powinien być nieformalnie sprawdzany.
SELF-REVIEW
Autor może samodzielnie wykonać pierwszą recenzję.
Użyj sprawdzania pisowni edytora tekstu, aby poprawić typowe błędy. Możesz użyć sprawdzania gramatyki edytora tekstu, jednak większość z nich jest niedokładna.
Przed wykonaniem tego przeglądu pozwól dokumentowi usiąść na dzień lub dwa. To pomoże ci zapomnieć o tym, co miałeś na myśli w swoim niejasnym piśmie. Kiedy robisz recenzję i pytasz :co miałem na myśli?: znalazłeś miejsce w dokumencie, który wymaga rewizji.
Dokonując przeglądu, wyobraź sobie, że jesteś użytkownikiem narzędzia i czytnika dokumentu. Wyobraź sobie zadania, które chce wykonać użytkownik narzędzia. Czy dokument pozwala Czytelnikowi znaleźć to, czego potrzebuje? Czy pisanie jest dokładne (poprawnie opisuje narzędzie), czy jest jasne i kompletne? Wprowadź zmiany, które poprawią dokument.
PRZEGLĄD ZEWNĘTRZNY
Następnie, jeśli to możliwe, użyj zewnętrznego recenzenta (w swojej firmie). Aby to zrobić, autor powinien:
1. Znajdź potencjalnego użytkownika narzędzia. Powinien to być ktoś, kto nie jest zaznajomiony z tym narzędziem i jak najbardziej zbliżony do grupy docelowej tego narzędzia.
2. Niech ten recenzent skorzysta z dokumentu, aby poprowadzić go / ją w użyciu narzędzia. Zachowaj komentarze do dokumentu. Zauważ proponowane zmiany, uzupełnienia, usunięcia, wyjaśnienia wymagane przez recenzenta. Niektóre pytania do zadawania mogą obejmować:
* Czy dokument mówi ci, co powinieneś wiedzieć?
* Czy łatwo znaleźć to, czego potrzebujesz w dokumencie?
* Czy dokument odpowiada na twoje pytania? Jeśli nie, jakie pytania pozostają bez odpowiedzi?
* Czy dokument jest łatwy do naśladowania? Jeśli nie, gdzie są obszary problematyczne?
3. Autor powinien wprowadzić niezbędne zmiany.
Jeśli nie możesz wykonać tej :semiformalnej: recenzji, to poproś kogoś, aby przeczytał dokument i przedstaw sugestie poprawy.
UWAGA
Upewnij się, że proces recenzji nie staje się zahamowaniem dla osób piszących dokumentację użytkownika dla użytkowników wewnętrznych. Podkreślaj mechanizm współpracy - a nie kontradyktoryjności - którego wynikiem jest praca o wysokiej jakości. Nie próbuj tworzyć idealnego dokumentu użytkownika.