Jakie jest najlepsze podejście do tworzenia instrukcji obsługi?
Instrukcje obsługi zawierają wskazówki dotyczące montażu, instalacji i użytkowania produktu. Podręczniki użytkownika mogą mieć różne formy, takie jak instrukcje użytkownika, podręczniki użytkownika, skrócone przewodniki startowe, podręczniki wprowadzające lub dokumentacja techniczna.
Kto zajmuje się pisaniem technicznym i jak to się robi?
Zwykle istnieją trzy sposoby tworzenia tekstów technicznych przez firmy, w tym podręczniki użytkownika i instrukcje. Zobaczmy, które podejście jest najlepsze i jak najlepiej wykorzystać każdą z metod.
1. Poproś personel techniczny o napisanie instrukcji obsługi
Wiele firm ma tendencję do przydzielania jednego lub zespołu pracowników technicznych do wykonania pracy pisarskiej. To może brzmieć jak sprytny pomysł.
W skład tego zespołu wchodzą inżynierowie produktu, programiści i projektanci. Oni są ojcami, twórcami. Wiedzą więc wszystko (jeśli nie każdy z osobna, to może w ogóle). Jednym słowem są to znawcy tematu. A jeśli wystąpi błąd lub błąd, są one również najlepszą referencją. 
W końcu po co zawracać sobie głowę rekrutacją i płaceniem dodatkowego pracownika, skoro najlepsze zasoby są właśnie dostępne? Nie jest to ani najlepszy pomysł, ani najtańszy. Chociaż personel techniczny jest jednym z punktów odniesienia dla podręcznika, niekoniecznie jest to najlepsza osoba do tworzenia podręcznika szkoleniowego. Dlatego:
Po pierwsze, czy są dobrymi pisarzami? Wiele osób technicznych, których głównym zadaniem jest projektowanie i rozwijanie produktu, nie jest zainteresowanych pisaniem i dokumentowaniem; z tego samego powodu nie zajęli się pisaniem zawodowo. Mogą myśleć, że mają inne pilne rzeczy do zrobienia, co jest prawdą, biorąc pod uwagę ich podstawowe zadania i obowiązki. Dlatego mogą nie być utalentowanymi pisarzami i nie chcieć zdobyć tych umiejętności. Jeśli jednak Twoi pracownicy techniczni są dobrymi pisarzami lub interesują się pisaniem, masz szczęście. To jednak nie wszystko.
Po drugie, osoby zaangażowane w rozwój techniczny produktu mają różne poglądy na jego temat. Mają skłonność do zakładania, że wiele informacji jest oczywistych, podczas gdy użytkownik, który korzysta z nich po raz pierwszy, z pewnością potrzebuje wyjaśnień. Prawdopodobnie wpadną w tę pułapkę pisania technicznego, podając szczegółowe informacje techniczne, które ich zdaniem są niezbędne, a jednocześnie nieprzydatne dla użytkownika.
Niektóre szczegóły są istotne dla inżynierów, ale nie pomagają przeciętnemu użytkownikowi. Dla użytkowników liczą się wyniki procesu technicznego i sposób, w jaki zaspokaja on ich potrzeby, a nie to, co kryje się za procesem.
Instrukcje muszą być zwięzłe i powściągliwe w szczegółach technicznych, a jednocześnie zawierać obszerne instrukcje i ostrzeżenia. Eksperci z danej dziedziny również prawdopodobnie będą używać technicznych słów i żargonu, uznając, że jest to w porządku. Mogą nawet wyjaśniać terminologię, odwołując się do innego słownictwa, co powoduje zamieszanie.
Wskazówki, jak sprawić, by ta metoda działała:
Jeśli chcesz poprosić swojego obecnego personelu technicznego o napisanie instrukcji, zaangażuj cały zespół. W ten sposób można mieć pewność, że zastosowane zostaną różne perspektywy.
2. Poproś personel techniczny o napisanie podręcznika i poproś redaktora/pisarza o jego korektę.
Tak to działa. Osoby techniczne piszą wersję roboczą i przekazują ją redaktorowi/pisarzowi technicznemu. W ten sposób istnieje większe prawdopodobieństwo, że standardy pisania zostaną spełnione. Autor uprości niektóre fragmenty, zastąpi żargon bardziej powszechnymi słowami, ujednolici cały styl, zastosuje pewne triki i uatrakcyjni go.
Ta metoda brzmi znacznie lepiej. Ale czy możesz zapewnić, że redaktorzy przede wszystkim wypełnią luki powstałe przez personel techniczny? Prawdopodobnie nie są w stanie odgadnąć wszystkich brakujących części i poprawić tego, co otrzymali.
Wskazówki, jak najlepiej wykorzystać tę metodę:
- Dobra współpraca może zaowocować stworzeniem profesjonalisty. Upewnij się, że połączyłeś ekspertów merytorycznych (twój zespół techniczny) z autorem/redaktorem i nie proś przypadkowych autorów o edytowanie dokumentu bez dodatkowych informacji.
- Upewnij się, że autor może często wracać do zespołu technicznego, aby omówić różne części lub gdy pojawi się pytanie. Poproś także zespół techniczny o sprawdzenie zredagowanego dokumentu, aby upewnić się, że treść techniczna została poprawnie dostrzeżona i przekazana.
3. Poproś pisarza technicznego o wykonanie tej pracy w ścisłej współpracy z zespołem technicznym
Zatrudnienie pisarza technicznego wydaje się idealną metodą. Posiadanie autora technicznego, który tworzy instrukcję od samego początku, mając jednocześnie możliwość ścisłej współpracy z zespołem technicznym, używania, testowania i studiowania produktu, to brakujący składnik doskonale przygotowanej instrukcji obsługi. Zdecydowanie zaleca się zatrudnienie specjalisty ds. technicznych do napisania instrukcji. Eksperci merytoryczni mogą przeglądać, komentować, wyjaśniać i edytować podczas omawiania funkcji i cech produktu.
Wspólne pisanie to magiczna sztuczka.
We wszystkich trzech podejściach współpraca jest kluczem do lepszego pisania. Narzędzia dokumentacyjne skupiające się na pracy zespołowej i zapewniające przestrzeń do efektywnej współpracy mogłyby ułatwić ten proces. Wiele narzędzi online stara się to ułatwić. Zacieśnianie współpracy to znacznie więcej niż tylko możliwość dzielenia się, komentowania i omawiania różnych części. 
Sonat zaczęła coraz bardziej skupiać się na promowaniu wspólnego pisania poprzez ulepszanie funkcji przepływu pracy, w których można zdefiniować zautomatyzowany proces. W tym procesie. W organizację może zaangażować się każdy, możliwe jest przypisanie różnych zadań i poziomów dostępu przy zastosowaniu automatycznych reguł; w rezultacie oszczędza dużo czasu na edycję.
Korzystając z Sonat, możesz zapobiec publikowaniu dokumentów o niskiej jakości i niemonitorowanych, oszczędzając jednocześnie mnóstwo czasu swoim redaktorom i ekspertom.
Dowiedz się więcej o funkcjach współpracy Sonat tutaj .