TechWord / Průmyslová dokumentace
Průmyslová dokumentace
Dokumentace pro stroje a zařízení, která obstojí v provozu i před kontrolou
Průmyslové zařízení je v provozu roky a projde rukama mnoha lidí: obsluhy, údržby, servisních techniků i revizních orgánů. Každý z nich potřebuje najít přesně tu informaci, kterou zrovna řeší, a spolehnout se, že je správná. Píšeme provozní a servisní manuály, které tomu odpovídají.
Co pro vás uděláme
Manuály, ve kterých technik najde, co hledá, a auditor, co vyžaduje
Provozní a servisní manuály jako hlavní disciplína
Naším chlebem jsou manuály pro obsluhu, údržbu a servis strojů a zařízení. Popíšeme uvedení do provozu, běžnou obsluhu, plánovanou údržbu i řešení poruch tak, aby se technik v dokumentu rychle zorientoval a nemusel volat na podporu kvůli každé maličkosti. Vycházíme z vašich podkladů, ať máte specifikace, výkresy, schémata, 3D model nebo jen prototyp na dílně.
Aktuální dokumentace po celou dobu provozu zařízení
Stroje a zařízení bývají v provozu desítky let a během té doby procházejí úpravami, modernizacemi i změnami řídicího softwaru. Veškerou dokumentaci proto důsledně verzujeme: ke každé konfiguraci zařízení dohledáte odpovídající verzi návodu, máte přehled o provedených změnách a kdykoli se můžete vrátit k předchozímu stavu. Při každé změně na zařízení dokumentaci aktualizujeme a sladíme všechny jazykové verze, aby obsluha i servis vždy pracovali s platnými informacemi a vy měli podklady připravené pro posouzení shody i případnou kontrolu.
Strukturovaná dokumentace pro éru AI
Pro zařízení, které se vyrábí ve variantách a průběžně se vyvíjí, nabízíme modulární dokumentaci podle celosvětových standardů technické dokumentace, jako je S1000D a DITA. Obsah rozdělíme na znovupoužitelné datové moduly. Změnu uděláte na jednom místě a promítne se všude. Ušetříte na aktualizacích i překladech a dokumentace zůstane konzistentní napříč celou produktovou řadou.
Strukturovaný obsah má ještě jednu výhodu: čte ho technik i AI. Datové moduly s jasnou hierarchií a metadaty jsou připravené pro vyhledávání, servisní asistenty a další nástroje, které dnes dokumentaci samy procházejí. Na takto strukturované dokumentaci lze postavit i asistenta pro servisní techniky, který odpovídá přímo z vašich manuálů. Připravujeme produktové informace pro éru AI.
Markdown a docs-as-code
U zařízení s firmwarem chce stále víc týmů dokumentaci tam, kde žije zbytek produktu: v Gitu, verzovanou stejně jako kód. Dodáme provozní i servisní manuály v markdownu, připravené do vašeho repozitáře a publikačního řetězce, takže dokumentace nezaostává za vývojem firmwaru.
Připraveno na nové nařízení o strojních zařízeních
Průmyslová dokumentace nese odpovědnost za bezpečnost. Od 20. ledna 2027 platí nové nařízení (EU) 2023/1230 o strojních zařízeních (Machinery Regulation 2027), které nahrazuje dosavadní směrnici, aktualizuje požadavky na návody a poprvé umožňuje dodávat je v digitální podobě. Pomůžeme vám dokumentaci na nová pravidla převést a připravit digitální návody tak, aby splňovaly všechny náležitosti.
Hlídáme povinné bezpečnostní pokyny, výstražné symboly, podklady pro CE i strukturu technické dokumentace (Technical File), kterou očekává kontrolní orgán. Obstojí u technika i při auditu.
Rozumíme strojům, které popisujeme
Nepíšeme jen obecné formulace, rozumíme tomu, co popisujeme. Do týmu patří lidé s technickým zázemím, kteří chápou, jak zařízení funguje, a poznají, když v podkladech něco nesedí. Přes 33 let pracujeme na dokumentaci pro spotřební elektroniku, měřicí techniku i těžká průmyslová zařízení, takže se ve vašem oboru zorientujeme rychle.
Lokalizace
Dokumentace v jazyce každého trhu, kam stroj dodáváte
Návod ke stroji musí být v úředním jazyce země, kde se zařízení uvádí do provozu. Divize TechWord Lingua s vámi projde cílové trhy a typy dokumentace a navrhne, jak jazykové verze udržovat po celou dobu životnosti stroje. U modulární dokumentace se po změně modulu překládá jen ta změna a terminologie zůstává stejná ve všech jazycích i napříč typovou řadou.
Jak spolupráce probíhá
- Konzultace nad zařízením, podklady a požadavky norem
- Návrh struktury dokumentace a nabídka s pevnou cenou
- Psaní kapitol po etapách, průběžně k připomínkám vašich techniků
- Překlady, sazba nebo export do vašeho publikačního řetězce
- Postprodukční aktualizace
Co od nás dostanete
- Provozní a servisní manuál ve formátu podle vašeho workflow (PDF, DITA, markdown)
- Podklady pro Technical File a označení CE
- Znovupoužitelné moduly pro další varianty a verze
Vyvíjíte stroj nebo zařízení, které potřebuje dokumentaci?
Ozvěte se nám na nezávaznou konzultaci.