Dokumentacja techniczna

Informacja o produkcie w wielu językach na dowolnym nośniku
Zadaj pytanie goto
Prośba o wysłanie informacji goto
Wsparcie goto

Jakie kryteria powinna spełniać dobra dokumentacja produktu?
▪
informacje powinny być prawdziwe i pełne,
▪
łatwe do odnalezienia, wykorzystania i zrozumienia oraz
▪
przeznaczone dla określonej grupy docelowej w konkretnym celu.
 

Dobre produkty powinny posiadać dobrą dokumentację

STAR dysponuje wieloletnim doświadczeniem w przygotowywaniu i opracowywaniu graficznym dokumentacji technicznej. Pracujący w STAR twórcy tekstów to wyspecjalizowani inżynierowie, którzy przygotowują dokumentację w językach niemieckim, angielskim, francuskim, włoskim i japońskim zgodnie z zasadami określonymi przez
▪
prawo, dyrektywy, normy i warunki odpowiedzialności za skutki wad produktu
▪
układ graficzny, skład i typografię
▪
pisownię, terminologię i reguły językowe
▪
katalogi, materiały referencyjne, glosariusze, indeksy, itp.

STAR – doskonały partner

Zajmując się rozwojem produktów i w codziennej pracy korzystając z opartego na formatach SGML/XML systemu do tworzenia tekstów GRIPS oraz systemu do przygotowywania publikacji SPIDER, STAR jest doskonale przygotowany do dostarczania najlepszych rozwiązań całościowych z pojedynczego źródła.
STAR przygotowuje dokumentację techniczną dla wielu różnego rodzaju zastosowań, które obejmują między innymi:
▪
instrukcje obsługi, montażu, naprawy, serwisu i diagnostyki
▪
katalogi części zamiennych, opisy produktów i podręczniki szkoleniowe
▪
instrukcje obsługi, podręczniki i systemy pomocy
▪
wytyczne obsługi technicznej zgodne z normami Spec1000
▪
katalogi części zamiennym zgodne z normami B007 lub Spec2000

Tworzenie tekstów technicznych

STAR przyjmuje do realizacji zarówno fragmenty projektów, jak i pełne projekty dokumentacji. Aby lepiej poznać wymagania klientów, w początkowym etapie realizacji projektu STAR odbywa szereg szczegółowych konsultacji obejmujących
▪
analizę istniejącej dokumentacji produktu
▪
analizę wymagań i zdefiniowanie celów
▪
pomysły dotyczące strukturyzacji i projektu dokumentacji przeznaczonej dla określonej grupy docelowej
▪
przygotowanie schematów struktury informacji
▪
wybór najodpowiedniejszych narzędzi
▪
rozwój narzędzi do zarządzania informacją
▪
rozwój rozwiązań z zakresu publikacji multimedialnych

Tworzenie tekstów i organizacja pracy

W pierwszej kolejności ustalany jest schemat procesu tworzenia tekstów. Na podstawie tego schematu rozwijany jest system organizacji pracy, który
▪
automatycznie inicjuje realizację poszczególnych etapów
▪
informuje pracowników o wykonanych czynnościach
▪
oraz monitoruje status realizowanych zadań.
Gwarantuje to zachowanie zgodności z ustalonym schematem działania, a zatem kontrolę jakości danych, a przy tym zmniejszenie ilości prac wykonywanych ręcznie.

Wdrożenie i realizacja

Specjaliści z firmy STAR gwarantują, że dokumentacja produktu będzie spełniać najwyższe wymagania postawione przez klientów. Aby to osiągnąć, w ramach pracy nad dokumentacją wyodrębnia się kilka etapów, między innymi
▪
doraźną kompilację odpowiednich pod względem technicznym materiałów źródłowych
▪
wybór/ strukturyzację informacji
▪
pracę nad tekstem w celu dostosowania go do oczekiwań zamierzonych grup docelowych
▪
wybór i zakup ilustracji
▪
wykonanie wersji próbnej i przedstawienie jej do oceny
▪
wdrożenie uzyskanych w ten sposób uwag lub nowych danych technicznych
▪
poprawki i zakończenie pracy nad tekstem
▪
opracowanie dokumentacji od strony wizualnej (obrazki, tekst, tabele)
▪
szczegółowy projekt graficzny
▪
korektę wykonaną przez lingwistów (np. z uwzględnieniem nowej pisowni niemieckiej)

Spójność terminologiczna i stylistyczna

Właściwością dokumentacji technicznej jest wielokrotne wymienianie lub opisywanie niektórych przedmiotów lub czynności. Pracownicy STAR przygotowujący tekst dokumentu dbają o jego spójność. Oznacza to, że ten sam przedmiot jest zawsze określany tym samym terminem, a jedna czynność opisywana w identyczny sposób.
Konsekwentne stosowanie się do tej zasady nadaje tekstowi jednorodność – nawet, jeśli nad jednym dokumentem pracuje równocześnie kilka osób.

Tworzenie tekstu zoptymalizowanego do tłumaczenia

Ponieważ dokumentacja jest z reguły tłumaczona na kilka języków, pracownicy STAR gwarantują przygotowanie tekstu zoptymalizowanego pod kątem późniejszego tłumaczenia w celu obniżenia kosztów tłumaczenia.

Język i tożsamość firmy

Pracownicy STAR przygotowujący tekst dokumentu przyjmują jako priorytet konsekwentne stosowanie indywidualnego języka i terminologii dostarczonych przez klienta i odpowiednich do specyfiki projektu. Zgodność z wytycznymi języka stosowanego w firmie klienta nie tylko zwiększa łatwość korzystania z dokumentacji, ale też usprawnia komunikację w środowisku międzynarodowym, a wreszcie stanowi istotny składnik indywidualnej tożsamości danej organizacji.

Grafika i ilustracje

Dobre ilustracje poprawiają zrozumiałość dokumentacji. Wraz z wyjaśnieniami zamieszczonymi w tekście stanowią znaczną pomoc dla użytkownika. Ilustracje są zrozumiałe na całym świecie, we wszystkich językach. Wielu grafików pracujących w firmie STAR posiada wiedzę techniczną niezbędną do prawidłowego wykonania ilustracji technicznej.
Graficy znają wiele zróżnicowanych technik rysunku, między innymi
▪
rysunek w perspektywie urządzeń technicznych z wykorzystaniem rzutu równoległego lub perspektywy zbieżnej
▪
rysunek liniowy
▪
rysunek półtonalny i w skali szarości
▪
kolorową grafikę
▪
rysunek złożeniowy
▪
fotografię i cyfrową obróbkę fotografii
▪
schematy 2D i 3D
▪
przekrój poprzeczny do materiałów szkoleniowych
▪
piktogramy
▪
grafikę prezentacyjną
▪
animacje
▪
grafikę reklamową
^ Do góry

Firma
Działania
Usługi
Tłumaczenia
Dokumentacja techniczna
Lokalizacja oprogramowania
Rozwój oprogramowania
Zarządzanie informacją
Publikacje elektroniczne
Produkty
Rozwiązania
Do pobrania