News

parson schult evodion-Mitarbeiter im technischen Schreiben

Bei evodion schreiben Software-Architekten und IT-Consultants Code-Dokumentation für entwickelte Softwarelösungen und User Stories für Anwendungsfälle. mehr ...

Empolis und parson werden Partner

Mit Empolis gewinnen wir einen neuen, wichtigen Partner. mehr ...

Blog

Eine Tasse auf Reisen #5 - die Auflösung

In welchem Land wurde die parson-Tasse fotografiert, haben wir Anfang Dezember gefragt. Die Frage war knifflig. Trotzdem kamen die meisten auf die richtige Antwort: Kuba. mehr ...

RDF is not XML – RDF serialization and iiRDS metadata

The world of technical writing loves XML. Its document type definitions are the foundation of structured authoring. XML and the underlying schemas structure the content of our information products. The benefits are twofold. Content is consistently structured and easy to read. Authors have an easier time writing the content. The structure provides guidelines for authoring. mehr ...

11.-13. November 2014. tekom-Jahrestagung in Stuttgart

parson ist mit mit drei Beiträgen bei der tekom-Jahrestagung 2014 vertreten.

Frank Ralf
Tutorial: Sonnenfinsternis in der Technischen Dokumentation

Wie bewegt man Entwickler, Dokumentation zu schreiben? Am besten, indem man sie in ihrer gewohnten (Entwicklungs-)Umgebung belässt. Eclipse ist eine integrierte Entwicklungsumgebung und bietet eine Reihe von Tools, die nicht nur Entwickler beim Erstellen von Softwaredokumentation unterstützen, sondern auch technischen Redakteuren die Arbeit erleichtern. In seinem Kurztutorial stellt Frank Ralf einige dieser Tools vor: Javadoc, Mylyn WikiText, IBM Information Architecture Workbench und oXygen.
 
Anhand konkreter Beispiele gibt Frank Ralf einen Überblick über Eclipse-Tools, die für die technische Dokumentation relevant sind. Technische Redakteure lernen diese Tools so weit kennen, dass sie entscheiden können, ob und wie sie die Tools in der Technischen Dokumentation verwenden können. Und sie können Entwicklern Tipps geben, wie sie Dokumentation ohne große Mühe in ihrer gewohnten Umgebung schreiben können. Denn je geringer der technische Aufwand, desto eher werden Entwickler bereit sein, Dokumentation zu schreiben.

Dienstag, 11. November, 16.15 - 18.00 Uhr
Zum Tagungsprogramm.
 
Mark Schubert und Frank Ralf
Workshop: DITA Diet – Beautiful on the Inside
 
DITA is huge. Not only regarding its impact in technical writing but also quite literally. The first time that someone new to DITA looks at the DITA specification they are probably overwhelmed by the sheer amount of elements. At least that was our experience. DITA 1.2 has over 500 elements, more than double the size of the first DITA version. That can make it difficult to move to DITA and also make it difficult for teams of technical writers to produce consistent output. In the worst case the complexity scares authors away or confuses them instead of providing guidance. That is why a lot of DITA authors use only a subset of the DITA standard. Such a subset can be defined by editing the DITA DTD.
 
In their workshop, Mark Schubert and Frank Ralf are going to take a closer look at the DITA DTD, its modular structure and methods of editing.
 
Mittwoch, 12. November, 11.15 - 13.00 Uhr
Zum Tagungsprogramm.

Ulrike Parson (parson) und Dr. Achim Steinacker (intelligent views)
Partnerpräsentation: Wer seine Dokumentation liebt, vernetzt sie
 
Semantische Netze repräsentieren Wissen, indem sie Objekte miteinander verknüpfen. In Unternehmen gibt es viele verschiedene Arten von Objekten, die zumeist in getrennten Systemen verwaltet werden: Produkte, Projekte, Mitarbeiter, Prozesse und vieles mehr. Ein semantisches Netz bringt diese Objekte in einen Zusammenhang: Es beschreibt die Eigenschaften der Objekte („ein Produkt hat eine Version“) und die Beziehungen zwischen den Objekten.
 
Anhand eines konkreten Projekts erläutern Ulrike Parson und Dr. Achim Steinacker, wie Informationen aus verschiedenen Unternehmensdatenbanken mithilfe eines semantischen Netzes integriert wurden. Parallel wurde die Entwicklerdokumentation auf DITA/XML umgestellt – eine wesentliche Voraussetzung für die Einbindung der Dokumentation in das Netz. Metadaten für die XML-Topics und -Maps wurden mit den Informationen angereichert, die für auswertbare Beziehungen im Netz sorgen.

Am Ende entstand ein semantisches Netz, das die Beziehungen zwischen Anforderungen, Testfällen, technischen Komponenten und Dokumentation visualisiert. Es ermöglicht individuelle Abfragen und Suchen, die die Rechte des jeweiligen Benutzers in den verschiedenen Systemen berücksichtigen. Der Zugriff erfolgt über ein Web-Portal, das häufig benötigte Informationen und Berichte komprimiert darstellt.

Mittwoch, 12. November, 12.15 - 13.00 Uhr
Zum Tagungsprogramm.

Hier finden Sie weitere Informationen über die tekom-Jahrestagung.

  • facebook
  • linkedin
  • xing