Technická dokumentace

Vícejazyčná produktová informace pro všechna média

Položit dotaz goto
Vyžádat si informaci goto
Podpora goto

Známky dobré produktové dokumentace:

informace musí být fakticky správné a úplné,
snadno dostupné, použitelné, srozumitelné a
zaměřené na konkrétního čtenáře a účel.
 

Kvalitní výrobky zasluhují kvalitní dokumentaci

STAR má mnohaleté zkušenosti v tvorbě a navrhování technické dokumentace. Redaktoři společnosti STAR jsou technickými odborníky a vytváří produktovou dokumentaci v řadě jazyků, včetně němčiny, angličtiny, francouzštiny, italštiny a japonštiny, v souladu s:
legislativou, směrnicemi, standardy a produktovou zárukou,
rozvržením, sazbou a typografií,
pravopisem, terminologií a zvláštnostmi národních jazyků,
příručkami, doporučeními, rejstříky a indexy atd.

STAR – váš skvělý společník

Jako autor a každodenní uživatel editačního systému založeného na SGML/XML GRIPS a publikačního systému SPIDER, je společnost STAR ve výborné pozici pro poskytování optimálního celkového řešení z jediného zdroje.
STAR tvoří technickou dokumentaci pro mnoho různých oborů včetně:
příruček pro řízení, montáže, opravy, údržbu a diagnostiku,
katalogy náhradních dílů, popisy a příručky k výrobkům,
manuály, správní příručky a systémy nápovědy,
předpisy technických služeb podle standardu Spec1000,
katalogy náhradních dílů podle standardů B007 nebo Spec2000.

Technická redakce

STAR přijímá jak zakázky menšího rozsahu, tak na zpracování kompletní dokumentace. Aby se lépe seznámili s potřebami zákazníka, zajišťují si pracovníci STAR nejprve zevrubné konzultace, zahrnující:
analýzy stávající produktové dokumentace,
analýzy potřeb a stanovení záměrů,
návrhy strukturování a provedení dokumentace určené pro konkrétní cílovou skupinu,
vývoj matric struktury informací,
výběr nejvhodnějších nástrojů,
vývoj řešení pro správu informací,
vývoj konceptů multimediální publikace.

Editační proces a pracovní tok

Nejprve je editační proces definován. Podle tohoto procesu je připraven systém pracovního toku, který:
automaticky provádí jednotlivé kroky,
příslušné pracovníky informuje o probíhajících činnostech,
pozorně sleduje stav procesů.
Díky tomu je dodržen stanovený proces a následně i vysoká kvalita dat a je omezen objem manuálně prováděné práce.

Provedení a realizace

Odborníci v společnosti STAR zajišťují, že produktová dokumentace předčí zákazníkovo očekávání. Aby tohoto cíle mohlo být dosaženo, bezpočet kroků je včleněn do procesu dokumentace, včetně:
shromáždění technicky vhodných místních zdrojových materiálů,
výběr/strukturování informací,
redakční úpravy, s ohledem na určené cílové skupiny,
výběr a schválení ilustrací,
tvorba návrhů a jejich předložení k posouzení,
začlenění výsledků posudku nebo nových technických údajů,
redakční úpravy a dokončení,
optimalizace pro prezentace (obrázky, text, tabulky),
podrobné rozvržení,
korektury jazykovými odborníky (např. z hlediska nového německého pravopisu).

Terminologická a stylová jednotnost

Technická dokumentace je charakteristická tím, že určité objekty nebo činnosti lze opakovaně uvádět nebo popisovat. Redaktoři společnosti STAR zajišťují textovou jednotnost. Jinak řečeno, tentýž objekt je vždy označen stejným výrazem a tatáž činnost je pokaždé popsána stejným způsobem.
Stálé dodržování tohoto principu vytváří jednotný styl dokumentace – a to i v případě, kdy se stejnými informacemi pracuje současně několik redaktorů.

Úpravy vyhovující překladům

Protože dokumentace je většinou překládána do řady jazyků, redaktoři ve STAR zajišťují, že je text vytvořen tak, aby se dobře překládal a zákazníkovi klesly náklady na překlad.

Firemní jazyk a identita

Pro redaktory ve STAR je naprostou prioritou zapojení a dodržování specifického jazyka a terminologie zákazníkova projektu. Shoda s podnikovým jazykem nezvyšuje pouze uživatelskou přívětivost dokumentace, ale tvoří také východisko efektivní komunikace v mezinárodním prostoru a je nepochybně zásadní součástí jednotné podnikové identity.

Grafika a ilustrace

S kvalitními ilustracemi je dokumentace srozumitelnější. Spolu s psanými vysvětlivkami poskytují uživateli maximální výhody. Obrázky jsou mezinárodním jazykem, kterému rozumí lidé po celém světě. Mnoho z grafiků ve STAR má technickou průpravu, což je pro správné sestavení technické ilustrace nezbytné.
Jsou zběhlí v celé řadě způsobů ilustrací, včetně:
perspektivní kresby technických výrobků, s využitím paralelního promítání nebo úběžníkové perspektivy,
perokresby,
obrázky v polotónu a stupních šedé,
barevné grafiky,
rozkladové nákresy,
fotografie, i digitálně upravené,
dvoj- a trojrozměrná schémata zapojení,
průřezové kresby pro výukové materiály,
piktogramy,
prezentační grafiky,
animace,
reklamní grafika
^ nahoru