Teknisk dokumentation

Teknisk dokumentation Produktinformation på flera språk för alla media
	Ställ en fråga
	Begär information
	Support

Kriterier för bra produktdokumentation

▪

Informationen ska vara faktamässigt korrekt och fullständig,

▪

lätt att hitta, använda och förstå, samt

▪

vara skriven för en specifik målgrupp med ett specifikt syfte.

mera information...

Bra produkter förtjänar bra dokumentation

STAR har många års erfarenhet av att producera och utforma teknisk dokumentation. STARs skribenter är specialister inom sitt område och skriver teknisk dokumentation på tyska, engelska, franska, italienska, japanska med flera språk, med hänsyn till:

▪

lagstiftning, direktiv, standarder och produktansvar

▪

layout och typografi

▪

stavning, terminologi och regionala språkregler

▪

kataloger, referenser, ordlistor och register, etc.

STAR – perfektion som partner

Som företaget bakom det SGML/XML-baserade redigeringssystemet GRIPS och publiceringsmotorn SPIDER, program som företaget inte bara utvecklar utan själva använder dagligen, har STAR en perfekt position för att ta fram den optimala helhetslösningen på just ditt företags problem.

STAR tillhandahåller teknisk dokumentation för alla slags områden, bland annat:

▪

bruks-, monterings-, reparations-, service- och diagnostikanvisningar

▪

reservdelskataloger, produktbeskrivningar och utbildningsmaterial

▪

användarhandböcker, administratörshandböcker och hjälpsystem

▪

tekniska serviceanvisningar enligt Spec1000

▪

reservdelskataloger som uppfyller B007 eller Spec2000

Teknisk redigering

STAR kan ta hand om hela dokumentationsprocessen eller delar av den. För att skaffa sig en klar bild av kundens behov erbjuder STAR inledningsvis omfattande konsulttjänster inklusive:

▪

analys av befintlig produktdokumentation

▪

behovsanalys och målformulering

▪

struktur- och designkoncept för målgruppsspecifik dokumentation

▪

utveckling av informationsstrukturmatriser

▪

val av verktyg som är bäst lämpat för uppgiften

▪

utveckling av informationshanteringslösningar

▪

utveckling av publiceringskoncept för multimedia

Redigeringsprocessen och arbetsflödet

Först och främst definieras en redigeringsprocess. Utifrån denna process utvecklas ett arbetsflödessystem som:

▪

automatiskt utför de olika stegen

▪

informerar berörda personer om de uppgifter som utförts

▪

och slutligen övervakar processtatus.

Detta för med sig att den föreskrivna redigeringsprocessen följs – och därmed, att datakvaliteten upprätthålls – samt att mängden manuellt arbete minskar.

Implementering och startfas

STARs specialister ser till att produktdokumentationen möter högt ställda kundförväntningar. För att uppnå det målet införlivas ett antal processteg i dokumentationsprocessen, till exempel:

▪

lokal kompilering av tekniskt korrekt källmaterial

▪

urval/strukturering av information

▪

redigering och bearbetning för den avsedda målgruppen

▪

urval och framtagning av bilder

▪

produktion av utkast och utskick för granskning

▪

införlivande av feedback från granskare, eller nya tekniska data

▪

redaktionell finputsning

▪

optimering av presentationssätt (bild, text, tabeller)

▪

detaljerade layoutmallar

▪

korrekturläsning utförd av språkvetare

Konsekvent bruk av termer och fraser

Det är typiskt för teknisk dokumentation att en beskrivning eller hänvisning till ett objekt eller en åtgärd upprepas gång på gång. STARs redaktörer ser till att texten är konsekvent. Med andra ord ser de till att ett givet objekt alltid benämns med en och samma term, och att ett givet arbetsmoment alltid beskrivs på samma sätt.

Genom att konsekvent hålla sig till denna princip blir stilen enhetlig dokumentationen igenom – även om flera skribenter arbetar parallellt med informationen.

Redigering optimerad för översättning

Eftersom dokumentationen i regel ska översättas till ett antal språk, ser STARs redaktörer till att texten blir skriven på det sätt som gör den bäst lämpad för översättning och för att hålla kundens översättningskostnader nere.

Koncernspråk och företagsidentitet

För STARs redaktörer kommer kund- och projektspecifik stil och terminologi alltid i första rummet. Att hålla sig till företagets språkliga riktlinjer gör det inte bara lättare att läsa dokumentationen. Det utgör dessutom grunden för effektiv kommunikation internationellt, och är i sista rummet en oundgänglig del av ett företags unika identitet.

Grafik och bilder

Bra illustrationer gör dokumentationen lättare att förstå. I kombination med skriftliga förklaringar ger de användaren det bästa av två världar. Bildspråket är internationellt och gångbart överallt i världen. Många av STARs grafiker och illustratörer har teknisk bakgrund, vilket borgar för att tekniska illustrationer blir rätt utförda.

De är väl förtrogna med ett stort antal grafiska tekniker, som:

▪

perspektivritning av tekniska produkter, med parallellprojektion eller flerpunktsperspektiv

▪

linjeteckningar

▪

halvtons- och gråskalebilder

▪

färggrafik

▪

sprängskisser

▪

foton; digitalt redigerade foton

▪

två- eller tredimensionella kopplingsdiagram

▪

tvärsnittsillustrationer för utbildningsmaterial

▪

piktogram

▪

grafik för bildspelspresentationer

▪

animeringar

▪

annonsgrafik

till början

Produktinformation på flera språk för alla media