News

tekom startet Developer Preview von iiRDS

Auf der Frühjahrstagung der tekom präsentierte die Arbeitsgruppe „Information 4.0“ den aktuellen Stand des neuen Content-Delivery-Standards iiRDS. mehr ...

Weißt du eigentlich, was du alles kannst? Wir suchen Verstärkung.

Wir entwickeln dich zum Experten für DITA, Projektmanagement, Entwicklerdokumentation, Github, Content-Delivery, Schreiben auf Englisch, Video-Tutorials, Terminologiearbeit. mehr ...

Blog

Technische Dokumentation zur SEO? Ein Gastbeitrag von Dr. Markus Nickl

Suchmaschinenoptimierung ist ein breites Feld: Man hat den Eindruck, dass es fast an jeder Ecke eine SEO-Agentur gibt. Obwohl hier Budgetquellen für die Technische Dokumentation ungenutzt bleiben, nimmt unsere Branche Suchmaschinenoptimierung aber bisher kaum als Thema wahr. Warum ist das so? mehr ...

Agile Dokumentation – funktioniert das?

Das Stichwort agil ist in der Softwareentwicklung mindestens so beliebt wie DITA in der Technischen Dokumentation. Kein Wunder: Agil und DITA konzentrieren sich auf Modularisierung und die Anforderungen der Nutzer. mehr ...

Glossar

Suche nach Begriffen im Glossar (reguläre Ausdrücke erlaubt).
Begriff Definition
Annotation

Metadaten, mit denen Informationen oder Quellcode strukturiert und beschrieben werden. Im Semantischen Web nutzen Computer oder Maschinen die Metadaten, um auf die Bedeutung von Informationen zuzugreifen und diese zu interpretieren.

API

Application Programming Interface. Ein Set von Routinen, Protokollen und Tools, das Programmierern den Zugriff auf die Funktionen eines Betriebssystems oder einer Anwendung ermöglicht und definiert, wie Software-Module interagieren. Eine API unterstützt auch unterschiedliche Programme dabei, Daten untereinander auszutauschen und kann damit ihre Funktionalität erweitern.

CCMS

Component Content Management System. Ein Redaktionssystem, in dem Dokumente auf der Basis von Komponenten organisiert werden. Jede Komponente stellt ein einzelnes Thema oder Konzept dar. Dabei kann es sich um ein Bild, eine Tabelle, eine Produktbeschreibung oder eine Vorgehensweise handeln.

Concept

Topic-Typ in DITA, der die "Was-ist-das-Frage" beantwortet. Wird für allgemeine Definitionen und Erklärungen verwendet. Concepts vermitteln dem Leser Hintergrundinformationen über ein Produkt oder andere für das Verständnis wichtige Informationen.

Confluence

Kommerzielle Software des australischen Unternehmens Atlassian für die Zusammenarbeit, Kommunikation und den Wissensaustausch im Unternehmen. Zum Beispiel können Aufgaben mit Fälligkeitsdatum und Berichte zu Seiten in Confluence hinzugefügt werden, sodass das gesamte Team auf dem Laufenden ist.

Content-Delivery-Portal

Content-Delivery-Portale bieten eine web-basierte Oberfläche für die Präsentation und das inhaltliche Erschließen umfangreicher Informationen und Dokumente. Die Inhalte des Portals sind mit Metadaten angereichert, um das zielgruppen- und kontextabhängige Filtern von Informationen und semantische Suchabfragen zu unterstützen. Die Inhalte selbst werden nicht im Portal erstellt, sondern kommen aus einem oder verschiedenen Autorensystemen.

DITA

Darwin Information Typing Architecture. Informationsarchitektur auf XML-Basis, die speziell für die Technische Dokumentation konzipiert wurde. Grundlage von DITA ist die Aufteilung von Inhalten in Bausteine, sogenannte Topics. Jedes Topic befasst sich mit einem bestimmten Thema.

DITA OT

DITA Open Toolkit. Open-Source-Tool für DITA, mit dem DITA-Inhalte in verschiedenen Formaten ausgegeben werden können, z.B. PDF, XHTML oder ODT.

DocBook

Frei verfügbares Informationsmodell, das in einer für SGML und XML vorliegenden Dokumenttypdefinition (DTD) festgelegt ist. DocBook bietet eine vorwiegend sequenzielle, buchähnliche Struktur für verschiedene Dokumentationsinhalte. DocBook ist ein offener und breit angelegter Standard für verschiedene Dokumentationsarten und bietet u.a. semantische Elemente für Soft- und Hardware-Dokumentation. Weit verbreitet bei Open-Source-Projekten.

DTD

Document Type Definition. Definiert die gültigen Elemente und Attribute in einem XML-Dokument und legt fest, wie diese verwendet werden und welche Unterelemente sie enthalten dürfen.

Folksonomy

Folksonomy (folk+taxonomy), auch Social Tagging genannt, ist eine Form von freier Verschlagwortung. Eine Folksonomy entwickelt sich, wenn viele Nutzer Texte auf bestimmten Seiten, z.B. Wikis, erstellen oder speichern und dann mittels Schlagwörtern kennzeichnen, worum es sich aus ihrer Sicht bei diesen Texten handelt. Die so erstellten Sammlungen von Schlagwörtern heißen Folksonomien. Folksonomien unterscheiden sich von Taxonomien: Folksonomien strukturieren Inhalt über User Tags; Taxonomien sind Klassifizierungen, die durch formalere Methoden bestimmt werden und nicht notwendigerweise nutzergenerierte Tags beinhalten.

Heuristische Analyse

Spezielle Untersuchungsmethode, mit der u.a. die Benutzerfreundlichkeit (Usability) von Produkten, z.B. Websites, Software oder Dokumentation, bewertet werden kann. Usability-Experten testen anhand einer Checkliste Schritt für Schritt ein Produkt. Die Checkliste beinhaltet eine Sammlung allgemein anerkannter Prinzipien (Heuristiken), die zur Bewertung der Usability herangezogen werden.

IDE

Integrated Development Environment (integrierte Entwicklungsumgebung). Eine Sammlung von Anwendungen für die Software-Entwicklung, die Editor, Compiler, Debugger und andere Komponenten enthält und in einer grafischen Oberfläche miteinander vereint.

Inkrement

In Scrum werden große Projekte in kleine und in sich abgeschlossene Inkremente zerlegt, die in einem Sprint fertig gestellt werden. Das Inkrement ist die Summe aller Backlog-Einträge für das Produkt, die während des aktuellen und aller vorangegangenen Sprints fertig gestellt wurden.

INVEST

Akronym, das für eine Checkliste von Kriterien steht, mit der als User Stories formulierte Anforderungen bewertet und verbessert werden können. I(ndependent). N(egotiable). V(aluable). E(stimatable). S(mall). T(estable).

  • facebook
  • linkedin
  • xing