Dokumentation Braun. Profil: Dokumentation Braun. Software Dokumentation aus Heidelberg. Dokumentation Braun

Transkript

1 Profil: Software Dokumentation aus Heidelberg

2 Inhaltsverzeichnis Warum Softwaredokumentation von?...3 Leistungsangebot Softwaredokumentation...3 Projektübersicht... 4 Werkzeuge... 4 Techniken... 5 Arbeitsproben...5 Artikel... 5 Benutzerhandbuch für Online Portal /5

3 Warum Softwaredokumentation von? Sie produzieren Software und brauchen Entwickler- und Benutzer-Dokumentation, wollen Ihre Terminologie kontrollieren und Software sowie Dokumente in weitere Sprachen übersetzen. Im Betrieb erwarten Sie jedoch folgende Herausforderungen: Ihre Entwickler und Architekten entwickeln lieber, statt die Software zu dokumentieren. Ihr Marketing ist sehr gut im Verkauf und erschließt Ihren Markt, macht gute Arbeit für Broschüren und gestaltet Ihre Web Präsenz. Die Dokumentation ist keine zentrale Dienstleistung der Abteilung. Hier hilft Ihnen. Wir sprechen mit den Entwicklern, konzipieren die notwendige Dokumentation - vom Architektur-White Paper bis hin zum Benutzerhandbuch und den Online Hilfen und setzen die Dokumentation dann um. Dabei hilft uns, dass wir die Sprachen beider Bereiche sprechen. Sowohl die Corporate Design-Richtlinien von Marketing als auch die Technik Informationen der Entwickler werden von uns in der Dokumentation umgesetzt, die dabei entstehenden Rückfragen werden von uns direkt mit Ihren Mitarbeiter geklärt. Die Effektivität und Effizienz Ihrer Mitarbeiter ist wichtig: Lassen Sie Entwickler entwickeln und Marketing den Markt für Sie erschließen die Dokumentation ist bei in guten Händen. Einen Einblick in die Tätigkeiten von gibt Ihnen das Leistungsangebot Softwaredokumentation, eine Projektübersicht, verwendete Werkzeuge und Techniken sowie Arbeitsproben. Leistungsangebot Softwaredokumentation ist für Sie da, wenn Ihr Software-Entwicklungsprozess einen Redakteur braucht bei der Konzeption der Dokumentation, bei der Erstellung von Entwicklungsprozess-begleitender Dokumentation, Benutzerhandbüchern, Online-Hilfen und Schulungsunterlagen, beim Betrieb von Redaktionsinfrastruktur bis hin zur Neugestaltung (Reengineering) von Redaktions- und Dokumentationsprozessen. Folgende Leistungen werden Ihnen angeboten: Software Dokumentation Dokumentation für Entwickler: Erstellung von Technical White Papers und weiterer Entwicklerdokumentation in englischer oder deutscher Sprache Dokumentation für Benutzer: Erstellung von Benutzerhandbüchern, Vertriebsdokumenten, Vertragsbeilagen und technischen Artikeln sowie Vorlagendokumenten und Redaktionsleitfaden in englischer oder deutscher Sprache Software: Erstellung von Online Hilfen Terminologiemanagement: Kontrolle und Organisation der Terminologie von Dokumenten und Benutzeroberflächen Übersetzung und Übersetzungsmanagement Kontrolle des Übersetzungsbudget, Koordination von Übersetzungsdienstleistern Übersetzung von Softwaredokumentation (Englisch > Deutsch) Beratung und Prozessoptimierung Dokumentationsmanagement: Organisation, Konzeption und Prozessentwicklung für Software Dokumentation Qualitätsmanagement: Qualitätsmanagement nach Ishikawa, Portfolio-Analyse, Aufgabenmanagement nach LOT 3/5

4 Betrieb von Infrastruktur Software-Betrieb: Ausschreibung, Auswahl, Einführung und Betrieb von Content-Management, Übersetzungs-Management, Terminologie-Management sowie Dokumenten-Management-Software Projektübersicht Dokumentation seit 1996 in deutscher und englischer Sprache für verschiedene Bereiche von Software Firmen: Entwicklerdokumentation, Benutzerhandbücher und Online Hilfen Angebots-, Projekt- und Abschlussdokumente Veröffentlichungen in Zeitschriften und Konferenzbänden Erstellung von Inhalten für Portale und Ereignisdokumentation Ein Auszug der Projektliste: Englischsprachige Entwicklerdokumentation bei Commerzbank AG Multimediale Dokumentation bei vsonix GmbH: Dokumentation von Konferenzen und Veranstaltungen mittels Video/Audio Dokumentation und parallelen textuellen Beiträgen Übersetzung bei Newport Spectra-Physics GmbH: Organisation des Übersetzungsmanagement, des Translation Memories sowie der Terminologie mit dem Übersetzungshilfewerkzeug OmegaT Entwickler-, Betriebs- und Benutzerdokumentation bei InterComponentWare AG (ICW): Entwicklerdokumentation, wie Java Docs, Technical White Papers und weitere, in Zusammenarbeit mit Entwicklern und Software Architekten Erstellung von Administrations- und Betriebshandbüchern in Zusammenarbeit mir der IT- und Betriebsabteilung Erstellung von Benutzerhandbücher, Vertriebsdokumente, Vertragsbeilagen und technische Artikel in Zusammenarbeit mit Projektmanagern Training und Bildung bei FH Wiesbaden: Organisation und Betreuung der Vorlesung 'Technische Redaktion für Informatiker' als Dozent Projektdokumentation und Berichte bei International Networks of Institutions for Computer Graphics (INI-GraphicsNet): Erstellung von Projektdokumentation, Abschlussberichten sowie Konferenzartikeln Werkzeuge Erfahrung mit Werkzeugen der Dokumentationserstellung (Auszug): MS Office OpenOffice, das kostenlose Office-Paket mit Text-, Tabellen- und Präsentationswerkzeug SAP KM als Dokumentenmanagementsystem MediaWiki als Wissensmanagementsystem OmegaT, das Trados-kompatibele, kostenlose Übersetzungshilfewerkzeug across, das Übersetzungs-und Terminologiemanagementsystem CMS Werkzeuge, wie Typo3 Build-Werkzeuge wie Maven 4/5

5 Werkzeuge für Technische Redaktion müssen nicht teuer sein. OpenOffice und OmegaT sind Beispiele für professionelle, kostenlose Software für Ihr Unternehmen. Techniken Erfahrungen mit Techniken der Dokumentationserstellung und Qualitätssicherung (Auszug): Strukturierung: Information Mapping, die Technik zur Strukturierung von Dokumenten Quality Assurance: Ishikawa Methode, Portfolio und List of Tasks (LOT) Projektmanagement: PMI PMBOK Arbeitsproben Artikel Name: Instrumente einer Telematik-Infrastruktur im Gesundheitswesen Beispiele transparenter Integration über Produkt- und Institutionsgrenzen hinweg Sprache: Deutsch Inhalt: Für die InterComponentWare AG wurde dieser Artikel geschrieben und im Telemedizinführer 2006 veröffentlicht. Dieser Artikel richtet sich an Fachpublikum und gibt einen Überblick über das ICW Produktportfolio im Zusammenhang mit der Einführung der Telematik-Infrastruktur im Gesundheitswesen. Der Artikel entstand in Zusammenarbeit mit den zuständigen Produktlinienleitern und Produktmanagern und wurde mit dem Management abgestimmt. Referenz: Norbert Braun, Ercan Elitok, Jörg Stadler, Thomas Waller; Instrumente einer Telematik-Infrastruktur im Gesundheitswesen Beispiele transparenter Integration über Produkt- und Institutionsgrenzen hinweg; In: Jäckel (Hrsg.) Telemedizinführer Deutschland, Bad Nauheim, Ausgabe 2006 Seite: Download: Benutzerhandbuch für Online Portal Sprache: Englisch (US-amerikanisch) Inhalt: Die Arbeitsprobe enthält einen Auszug aus dem Benutzerhandbuch eines Online Portals. Das Benutzerhandbuch richtet sich an den Laien und Gelegenheitsnutzer des Portals. Für die deutsche Lokalisierung wurde das Benutzerhandbuch sowohl in deutscher als auch englischer Sprache zur Verfügung gestellt. Als Auszug ist ein Kapitel aus der englischsprachigen Version gewählt, das die Funktionen Kalender des Portals beschreibt. Die Arbeitsprobe ist im Anhang dieses Dokuments angefügt. 5/5