Nowoczesna dokumentacja techniczna zwiększa bezpieczeństwo i kształtuje wizerunek firmy

Dokumentacja techniczna jest ważną częścią produktu naszych klientów, podnoszącą jego jakość. Jest ona wymagana przez prawo, zwiększa bezpieczeństwo produktu i poprawia jego użyteczność. Dokumentacja wysokiej jakości, zarówno pod względem treści, jak i układu, kształtuje wizerunek firmy. Z naszego doświadczenia wynika, że dokumentacja techniczna często bywa przygotowywana chaotycznie, przy użyciu różnorodnych programów pakietu Office lub systemów klienta. Zauważyliśmy wyraźną potrzebę poprawy jakości i uproszczenia sposobu tworzenia dokumentacji. Chcieliśmy zapewnić naszym klientom nowoczesny proces, a zwłaszcza elastyczność wdrożenia, poprzez wprowadzenie systemu dokumentacji DITA CMS (Content Management System).

W 2017 r. rozpoczęliśmy prace rozwojowe dotyczące działalności związanej z dokumentacją techniczną, aby zapewnić klientowi nowy sposób jej tworzenia. W dziale eksperckim firmy Comatec stworzono zespół ds. dokumentacji kierowany obecnie przez Tomiego Salmivuori.

„W wyniku prac rozwojowych wdrożyliśmy system dokumentacji strukturalnej, który nie jest powiązany z żadnym innym konkretnym. System CMS jest dostarczany przez Dox Systems, który jest naszym partnerem przy takich pracach rozwojowych. Wspólnie z naszym dostawcą opracowaliśmy własny Comatec CMS, który teraz wykorzystujemy do pracy podczas tworzenia dokumentacji” – mówi Salmivuori.

– Zespół ds. dokumentacji stale się powiększa. Teraz pracuje u nas około dziesięciu osób, a celem jest dalsze, coroczne powiększanie zespołu. Stosujemy CMS również w Comatec Poland i zamierzamy nadal zwiększać jego wykorzystanie. Ugruntowaliśmy naszą pozycję w branży dokumentacji, a popyt na te usługi pozostaje duży.

System CMS Comatec

System CMS firmy Comatec to system oparty o standard LW DITA. Materiał składa się z modułów, których powtarzalna treść jest zapisywana tylko raz, zgodnie z zasadami jednego źródła. Dotyczy to zarówno tekstu, jak i ilustracji. System umożliwia również zarządzanie grafiką, wersjami językowymi, rewizjami i wyglądem publikacji. Na przykład, jeśli pojawi się nowy model produktu, zawartość zostanie zaktualizowana tylko w odpowiednich częściach lub do systemu zostaną dodane tylko nowe części dokumentu. Stroną graficzną dokumentacji można łatwo zarządzać za pomocą plików stylów. Jeśli wygląd zostanie zmodyfikowany, łatwo zaktualizować jego zmianę w pliku stylu, bez konieczności przeglądania wielu dokumentów strona po stronie. Zarządzanie grafikami w różnych dokumentach i wersjach językowych jest bardzo łatwe, ponieważ nawet zlokalizowane w różnych miejscach mogą być ze sobą połączone. System działa w przeglądarce jako usługa w chmurze (SaaS). Jest elastyczny i przyjazny dla użytkownika. Jeśli na przykład istnieje pilna potrzeba edycji instrukcji, można to zrobić w dowolnym miejscu i czasie.

– Współpracowaliśmy z Comatec nad opracowaniem systemu w oparciu o opinie i życzenia ich klientów. W przyszłym roku w systemie pojawi się znacząca dodatkowa funkcja, mówi Mikko Tauriainen z Dox Systems.

– Opowiemy o tym więcej w naszym następnym magazynie dla klientów, mówi Salmivuori.

Comatec CMS jest niezależny

Ważną cechą systemu jest jego niezależność. Strukturę można wprowadzić do systemu z innych podobnych, co ułatwia jego wymianę. Ani klient, ani świadczona przez nas usługa nie są zależni od tego systemu, w którym jest on wdrożona. Ponadto Comatec CMS nie wiąże się z żadną poważną inwestycją dla klienta. Cała dokumentacja techniczna klienta może zostać obsłużona i wygenerowana przez Comatec. Klient może jednak również korzystać z systemu na własny użytek, co pozwala jego pracownikom edytować dokumenty. Zawsze istnieje możliwość znalezienia procedury dopasowanej do sposobu korzystania z systemu przez klienta. Wszystkie informacje w systemie są własnością klienta.

Klient korzysta nie tylko z systemu, ale i z profesjonalnej wiedzy i doświadczenia zespołu Comatec.

– Niezależnie od tego, czy konieczna jest weryfikacja procesu dokumentacji technicznej, zaprojektowanie nowego materiału czy zaktualizowanie już istniejącego, pomoże Ci nasz doświadczony zespół. Projektujemy i piszemy treści oraz tworzymy publikacje dla wszystkich rodzajów dokumentów technicznych, od instrukcji obsługi, konserwacji i instalacji po publikacje dotyczące części zamiennych, jak również materiały szkoleniowe. – W razie potrzeby możemy również wykonać ilustracje do publikacji– mówi Salmivuori.

Wielu z naszych klientów to producenci maszyn i urządzeń – mamy wiedzę i doświadczenie, pozwalające nam tworzyć dobrej jakości dokumentację zarówno do maszyn jak i całych linii produkcyjnych.

Zobacz inne, świadczone przez nas usługi