doku-abteilung Blog

Standardformulierungen für Bedienelemente

Standardformulierungen für Bedienelemente

Wann ist es besser, vereinheitlichte Begriffe zu verwenden? Und wann ist es besser, Bedienelemente und Aktionen genau zu bezeichnen? Nicht nur viele Benutzer, auch mancher Redakteur gerät angesichts der Begriffsvielfalt ins Straucheln: Da wird geklickt, aktiviert, angewählt, abgewählt oder ausgewählt. Mal laufen auf Rechnern Programme, mal auf Computern, Software, dann wieder laufen...

Teile diesen Beitrag
Terminologie in der Softwaredokumentation

Terminologie in der Softwaredokumentation

Wählen, aktivieren oder Klicken? Welche Regelungen gelten für die Terminologie von Softwaredokumentation und Online-Hilfen? Wann ist es besser, vereinheitlichte Begriffe zu verwenden? Und wann ist es besser, Bedienelemente und Aktionen genau zu bezeichnen? Nicht nur viele Benutzer, auch mancher Redakteur gerät angesichts der Begriffsvielfalt ins Straucheln: Da wird geklickt, aktiviert, angewählt, abgewählt oder ausgewählt....

Teile diesen Beitrag
Sicherheitszeichen

Sicherheitshinweise in Gebrauchsanleitungen

Ein Sicherheitshinweis (nicht Warnhinweis) ist nach EN 82079 eine „sicherheitsbezogene Information, die nach einem sinnvoll organisierten System in einem Dokument oder Abschnitt eines Dokuments gesammelt oder gruppiert sind, um Sicherheitsmaßnahmen zu erklären, Sicherheitsbewusstsein zu wecken und eine Grundlage zur sicherheitsbezogenen Schulung der Nutzer zu schaffen“. Ein Sicherheitshinweis dient dazu Personen und auch andere Lebewesen oder...

Teile diesen Beitrag
Was macht ein Technischer Redakteur?

Was macht ein Technischer Redakteur?

Sie sind technischer Redakteur oder interessieren sich zumindest für technische Redaktion? Vermutlich schon, denn sonst wären Sie nicht hier. Gut für Sie. Technische Dokumentation gewinnt nämlich an Bedeutung. Hochwertige Dokumentation ist ein Qualitätsmerkmal, mit dem sich Unternehmen profilieren können. Technische Redakteure sind also gefragt. Grund genug, einmal genauer hinzusehen, was...

Teile diesen Beitrag
Terminologie der technischen Kommunikation

Terminologie der technischen Kommunikation

Die Terminoligie der Technischen Kommunikation hat eine normativen Charakter: In jeder Sprache gibt es pro Eintrag genau eine Vorzugsbenennung; diese sollte immer verwendet werden. Die Benennungen, die Einzelfällen auch verwendet werden dürfen, erhalten das Attribut „erlaubt“. Die nicht zu verwendenden Benennungen erhalten dagegen das Attribut „abgelehnt“. Status einer Benennung bevorzugt...

Teile diesen Beitrag
Beispiel für ein Jobprofil

Beispiel für ein Jobprofil

Profil – Junior Technischer Redakteur Kurzbeschreibung Der Junior Technischer Redakteur ist am Erstellungsprozess der Informationsprodukte beteiligt. Dabei übernimmt er vor allem die Inhaltsbeschreibung. Hauptaufgaben Umgang mit Rechten und Normen, zusätzliche Normenrecherche Planungstätigkeiten zu den eigenen Aufgaben Informationsbeschaffung Inhaltserstellung mit der dazugehörigen Tool-Kenntnis Archivierung der erstellten Inhalte Feedback zu erstellten Inhalten...

Teile diesen Beitrag
Scrum-Methode

Scrum-Methode in der Technischen Dokumentation

Scrum-Methode – Planen auf Sicht und regelmäßige Absprachen im gesamten Team: Diese Eigenschaften prägen Scrum – eine der bekanntesten Methoden in der agilen Entwicklung. In diesem Beitrag wird es als Projektmanagementinstrument vor, zeigen die Rolle von Technischen Redakteuren in Scrum-Teams auf und diskutieren, welche Chancen die Methode bieten kann. Die...

Teile diesen Beitrag
Benennungsregeln

Allgemeine Benennungsregeln

Genauigkeit, Eindeutigkeit, Übersetzbarkeit Nicht Messstab, nicht Motorölmesstab, sondern Ölmesstab (auch passend für Motoröl, Hydrauliköl oder Getriebeöl) Nicht Sitz, nicht Vordersitz, sondern Beifahrersitz. (Auch der Fahrersitz ist ein Vordersitz) Nicht Leitung, sondern elektrische Leitung, hydraulische Leitung, pneumatische Leitung. (Das Wort „Leitung“ allein lässt sich nicht eindeutig übersetzen.) Nicht Motoröl-Auffangsbehälter, sondern Auffangbehälter...

Teile diesen Beitrag
Checkliste zur Erstellung von Anleitungen

Checkliste zur Erstellung von Anleitungen

– unter Berücksichtigung der Maschinenrichtlinie 2006/42/EG, EN ISO 12100:2010 und EN 82079-1:2012 Checkliste zur Erstellung von Anleitungen – Häufig fehlen Unternehmen im stressigen Alltag die Zeit und/oder das Wissen für eine gründliche Recherche der relevanten Gesetze, Verordnungen, Richtlinien und Normen für die Erstellung von technischer Dokumentation. Denn die technische Dokumentation...

Teile diesen Beitrag