|
Usługa partnerska STI i FourPeople GmbH
Instruować
Teksty instruktażowe przekazują informacje ukierunkowującą czytelnika bezpośrednio na działanie. Przekazuje się co, jak, gdzie i dlaczego coś należy robić albo czegoś przestrzegać. Funkcją tekstu jest nakłonienie czytelnika, aby coś zrobił albo czegoś zaniechał. Ponieważ reakcja musi być natychmiastowa, a nikt nie chce przeczytanymi wytycznymi zaśmiecać sobie pamięci długoterminowej, przy opracowaniu tekstów instruujących nadaje się językowi taką formę, aby spełnił dokładnie taką funkcję, do jakiej go przewidziano: ma instruować do niezwłocznego działania!!!
Opracowujemy:
Instrukcja obsługi zawiera inne elementy niż dokumentacja techniczno-ruchowa, i to zarówno pod względem językowym, jak i technicznym. W końcu mają to być teksty instruujące w sprawach związanych z obsługą a nie wgłębiające się w tajniki pracy danego urządzenia! Te subtelne różnice stanową rdzeń pracy naszych redaktorów, którzy mając je na uwadze, dokładnie i starannie tworzą odpowiednie dokumenty. O tym, jakiego rodzaju dokumentacja jest potrzeba w Twojej firmie zadecydujemy razem po dokładnej analizie! W słowniku można znaleźć wyjaśnienie, że dokumentacja techniczno-ruchowa (DTR) to instrukcja umożliwiająca eksploatację maszyny. Dzisiaj pojęcie to należy rozszerzyć, ponieważ maszyny, urządzenia, układy - wszystkie te produkty wymagają odpowiednich instrukcji. Nie są one dekoracją do produktu, tylko stanowią jego integralną część.
DTR-ka jest instrukcją użytkowania dla urządzeń albo układów. Ustawy, dyrektywy i normy zobowiązują producenta i podmiot wprowadzający do obrotu do jej wykonania. Od dawna już przepisy też wypowiadają się dość konkretnie na temat zawartości i formy tych dokumentów.
Czy deklaracja zgodności jest częścią DTR-ki? Czy muszę pisać o tym, czego mi nie wolno? Jaką wielkością czcionki należy pisać instrukcje?
Nasza codzienność to szukanie odpowiedzi na powyższe pytania!
Poza tym DTR-ka to dla profesjonalnych redaktorów podstawowy produkt w zakresie dokumentacji technicznej, a jej dobre opracowanie to sedno jego kompetencji. Krótko i na temat: instrukcja użytkowania to instrukcje skierowane do użytkownika na temat sposobu użytkowania produktu. Słownictwo techniczne ustępuje tu pierszeństwa językowi możliwie najbardziej przyjaznemu użytkownikowi, co stanowi tutaj najważniejszą różnicę w porównaniu z dokumentacją techniczno-ruchową.
Nawet jeżeli sama nazwa nie zawiera w sobie słowa instrukcja, to jednak również tutaj mamy do czynienia z tekstami instruktażowymi. Pytanie o to, kiedy jest rzeczą celową nie zawierać instrukcji serwisowych w DTR-kach i opracować osobne podręczniki serwisowe, to pytanie na które obok innych staramy się również znaleźć odpowiedź. Jako profesjonaliści w branży dokumentacyjnej, staramy się przygotować dla naszych klientów rozwiązania odpowiadające potrzebom rynkowym.
Jaki rodzaj tekstu jest odpowiedni dla Państwa produktu zależy ostatecznie tylko od jego specyfiki, a dana instrukcja musi też spełniać wymogi obowiązujących regulacji ustawowych, pasować do CI firmy, posiadać przejrzystą strukturę i zawierać instrukcje odpowiednie w formie i treści dla zdefiniowanej uprzednio grupy odbiorców! Jest jeszcze wiele innych czynników, które starannie analizujemy – opracowane przez nas dokumenty to nie produkt standardowy, towarzyszy im szczegółowe doradztwo przed rozpoczęciem pracy. Pozwala nam to uniknąć przykrych niespodzianek po fakcie!
Myślimy też o tym, aby pielęgnacja instrukcji nie stanowiła dużego nakładu pracy! Ale wszyscy wiemy, że czasami zmiany przepisów (ustawa o ogólnym bezpieczeństwie produktów z ....) wymuszają dostosowanie instrukcji, a zminimalizowanie przyszłych nakładów roboczych da się tylko częściowo przewidzieć.
Opisywać
Teksty opisowe to również pewien rodzaj technicznej dokumentacji produktowej. Przekazują nam one informacje, a my nadajemy im odpowiednią formę. Jako profesjonaliści wiemy, że wybrana forma jest wyznacznikiem jakości i musi być przyjazna w użyciu. Poza tym zawarte treści muszą być przekazany w sposób jasny i zrozumiały dla użytkownika.
Nasza codzienność to opracowywanie dokumentacji opisowej w następujących formach:
W przypadku arkuszy danych technicznych, mamy do czynienia z prostą formą tekstów opisowych - tak właśnie niektórzy sądzą! Opinię tą podzielamy tylko częściowo!
Arkusze danych technicznych to wyzwanie z punktu widzenia ponownego wykorzystania tekstów. Dzięki starannemu doborowi sformułować w arkuszach danych technicznych, sprytnym połączeniom do informacji źródłowych oraz optymalnemu doborowi wybranych narzędzi można stworzyć produkt umożliwiający klientowi trwałe i znaczne oszczędności! Pomoc Online ma pomóc operatorowi w obsłudze oprogramowania albo urządzenia. Wielu producentów utożsamia niestety pomoc online z podręcznikami w PDFie albo zbiorem linków, które przekierowują użytkownika na stronę producenta albo jakieś forum.
Ale kto by chciał najpierw drukować 500 stron podręcznika, zanim znajdzie rozwiązanie swojego aktualnego problemu – i to możliwe, że właśnie problemu dotyczącego drukarki!?
Przy tym prawdziwa pomoc on-line oferuje szeroki zakres funkcji wyszukiwania albo linków dotyczących podobnych tematów w obrębie systemu pomocy, które wyraźnie przyczyniają się do rozwiązania problemu.
Często zapomina się też o funkcjach wspierających użytkownika przed albo podczas instalacji oprogramowania albo urządzenia. W takim przypadku często nie ma jeszcze dostępu do pomocy on-line.
STI wraz z Fourpeople GmbH opracowuje systemy pomocy, które pomagają użytkownikowi w rozwiązaniu problemu. Zarówno przed, podczas, jak i po instalacji oprogramowania czy urządzenia. "Łącząc ze sobą wzorzec układu wydruku dokumentu z wzorcem układu wydruku wzorca układu wydruku, można zaktualizować wzorzec układu wydruku wzorca układu dokumentu. Połączenie wzorca układu wydruku dokumentu z wzorcem układu wydruku, powoduje podmianę definicji wzorca formatu wydruku na definicje wzorca druku wzorca dokumentu o tych samych nazwach. ....". (z podręcznika WinWord 2.0)
Tego nikt tak naprawdę nie chciał napisać, ponieważ tego tak naprawdę nie da się zrozumieć! Jasne i proste definiowanie związków przyczynowo-skutkowych w zrozumiałej konwencji językowej należy do głównych umiejętności redaktora, natomiast pisanie oprogramowania do zadań programisty. Dzięki temu robimy dokładnie to, na czym się znamy, a nasi klienci są zadowoleni.
Państwo przekazują nam informacje, a my nadajemy im odpowiednią formę.
- lekkość redakcyjna
- przyjazność dla użytkownika
- trwały przekaz
Więcej o dokumentacji produktowych możesz dowiedzieć się z artykułów:
 Wewnętrzna redakcja techniczna – zło konieczne czy strategia marketingowa i dystrybucyjna?.pdf [1.47 Mb]
Dokumentacja techniczna i jej pułapki.pdf [649.63 Kb]
|
Instrukcje obsługi
