Aktualizacja: 29.08.2017 r. W dzisiejszych czasach mamy dostęp do wprost niewyobrażalnie dużej ilości informacji. Można powiedzieć, iż mamy do czynienia z przeładowaniem informacjami, jesteśmy nimi bombardowani, gdziekolwiek się nie udamy. Naturalnie nie jesteśmy w stanie przetworzyć wszystkich informacji, które do nas docierają, jednak podstawowy problem stanowi nie trudność w ich przyswojeniu, lecz w odnalezieniu w informacyjnym gąszczu tych dla nas przydatnych. Problem ten dotyczy również wszelkiego rodzaju dokumentacji urządzeń, jakimi się posługujemy. Dokumentacja techniczna: opisy techniczne, obliczenia konstrukcyjne, rysunki, plany, kosztorysy i harmonogramy.

Jak napisać stworzyć dokumentację techniczną Dokumentacja techniczna aplikacji programów projektu systemu informatycznego opisy techniczne, obliczenia konstrukcyjne, rysunki, plany, kosztorysy i harmonogramy.

Pytania, jakich wymaga dopracowana dokumentacja techniczna

Zapewne wielu z nas, borykając się z technicznymi problemami, miało okazję szukać odpowiedzi na nurtujące nas pytania w instrukcji obsługi danego produktu. Wertując kartki instrukcji, napotykamy na opis produktu, proces tworzenia, a nawet informacje dotyczące samego producenta. Znalezienie odpowiedzi na konkretne pytanie graniczy wtedy z cudem. Spędzamy mnóstwo czasu, zapoznając się z możliwym zastosowaniem poszczególnych funkcji urządzenia, co powoduje znaczne obniżenie naszej efektywności. W rezultacie jesteśmy sfrustrowani i nie jesteśmy w stanie samodzielnie poradzić sobie z powierzonym nam zadaniem.

Tu zastosowanie znajduje minimalizm. Jang F.M. Graat, właściciel firmy konsultingowej Jang Communication, twierdzi, iż esencją minimalizmu jest postawienie się w sytuacji użytkownika. Jego celem jest zminimalizowanie wysiłku po stronie klienta poprzez zastanowienie się, jakich informacji może potrzebować potencjalny użytkownik danego produktu. Dla użytkownika najbardziej istotne jest prawidłowe posługiwanie się narzędziami, a także rozwiązywanie problemów powstałych w trakcie pracy z danym urządzeniem.

Należy pamiętać, iż produkt nie jest celem samym w sobie i nie istnieje bez jego użytkownika. Jeżeli klienci znajdą produkt pozwalający im szybciej i łatwiej wykonać dane zadanie, z pewnością zrezygnują z poprzedniego produktu na rzecz tego, z którym pracują bardziej wydajnie.
Dlatego właśnie tak istotne jest odpowiednie opracowanie instrukcji obsługi. Dokonać tego możemy, stosując się do kilku prostych zasad.

Po pierwsze, instrukcja obsługi taka powinna zawierać wąskie i sprecyzowane rozdziały stanowiące odpowiedzi na konkretne pytania np. „W jaki sposób wykonać pewną operację?”, bądź „Co zrobić w sytuacji gdy?”.
Jeden taki rozdział odpowiada z reguły na jedno pytanie, co pozwala użytkownikowi szybko odnaleźć informację, której potrzebuje. Nie musi on więc czytać całej obszernej części instrukcji poświęconej danej funkcji, a jedynie krótką i zwięzłą odpowiedź na jego pytanie zawierającą niezbędne szczegóły.

Dobra dokumentacja techniczna jest zwięzła

Dokumentacja techniczna to nie tylko podręcznik użytkownika zawierający dane techniczne i instrukcję montażu. Karta produktu, deklaracja zgodności, przykłady instalacji, wytyczne projektowe…

Ze względu na zakres formalny dokumentacja techniczna to m.in.:

  • prace studialne
  • prace normatywne
  • normy, zmiany i poprawki norm
  • normatywy i wytyczne techniczne
  • katalogi i albumy detali
  • techniczne biuletyny informacyjne
  • informatory i foldery
  • paszporty obiektów.

Nie zawsze należy stosować dosłowny przekład. Jeśli nie jest to tłumaczenie patentów, pomocne może być użycie wizualizacji. Diagramy, czy ryciny zastępują niejednokrotnie obszerne i skomplikowane opisy poszczególnych kroków, jakie powinien wykonać nabywca.
Błędem byłoby użycie zarówno tego rodzaju wizualizacji, jak i tekstu, ponieważ wydłużyłoby to z pewnością czas, jaki klient spędziłby na przetworzeniu informacji. Jeżeli istnieje możliwość mylnej interpretacji obrazu, jakiego planujemy użyć, należy zamieścić obraz o lepszej jakości bądź zrezygnować z niego na rzecz opisu.

Spójna nomenklatura (terminologia techniczna)

Ważna jest również spójność, czyli konsekwencja w doborze słownictwa. Jeżeli zdecydujemy się na używanie danego terminu do określenia pewnej opcji, części urządzenia, bądź czynności, należy używać tego określenia konsekwentnie. Bogactwo językowe jest tu zbędne, gdyż celem nie jest stworzenie dzieła literackiego, a zrozumiałej instrukcji postępowania w określonych sytuacjach. Zasada ta dotyczy również struktury, jaką nadamy instrukcji obsługi. Budowa poszczególnych sekcji powinna być schematyczna, ponieważ użytkownicy przyzwyczajają się do niej i wyszukanie odpowiedzi na nurtujące ich pytania staje się z czasem dużo łatwiejsze.
W trakcie opisywania czynności najlepiej używać trybu rozkazującego. Dzięki temu budujemy krótsze, prostsze zdania. Należy zrezygnować z rozbudowanych zdań i usuwać te, które nie niosą żadnej istotnej, nowej informacji z punktu widzenia klienta.

Ogromne znaczenie ma ponadto sposób, w jaki uporządkujemy informacje. Odpowiednie grupowanie informacji, stworzenie łatwego w użytku spisu treści, a także platformy umożliwiającej użytkownikom wyszukanie odpowiedzi na ich pytania może okazać się kluczem do sukcesu.
Co prawda stworzenie takiej instrukcji wymaga dużo więcej wysiłku, a może nawet nakładów finansowych, ale daje również ogromne korzyści. W przypadku instrukcji stworzonej z zastosowaniem zasad minimalizmu zmiana jednej z funkcji produktu nie spowoduje konieczności tworzenia nowej lub modyfikacji całości już posiadanej instrukcji, ale zmianę tylko jednej bądź kilku jej sekcji odpowiadających na konkretne pytania dotyczące tejże opcji.

Uproszczenie opisów czynności, zamieszczanie rycin zamiast całych stron tekstu, a także eliminacja powtórzeń spowodują również obniżenie kosztów druku instrukcji, czy jej tłumaczenia.

Dobra dokumentacja techniczna przekłada się na zadowolenie klienta

Najważniejszą zaletą minimalizmu jest jednak satysfakcja klienta.

Niezależnie od tego, jak zaawansowany technologicznie jest produkt, zbyt obszerna, niejasna instrukcja obsługi może spowodować popełnienie szeregu błędów przez klientów, marnowanie ich cennego czasu, ich frustrację i brak rezultatów, co prowadzi do ich negatywnej oceny produktu. Klienci tacy prawdopodobnie nie zdecydują się na kupno innych produktów danej firmy ani nie polecą jej wyrobów znajomym. Dlatego też z pewnością można stwierdzić, że instrukcja obsługi ma wpływ na popularność danego produktu, a także wizerunek producenta. W tym wypadku minimalizm oznacza zadowolenie użytkowników.

Minimalizm a dokumentacja techniczna: mniej znaczy więcej
Ocena: 5 (100%) na podstawie 1 ocen(y).

Rozmiar
Kontrast