ubuntuusers.de

[Neuer Artikel] DITA Single Source Publishing Umgebung

Status: Ungelöst | Ubuntu-Version: Nicht spezifiziert
Antworten |
Dieses Thema ist die Diskussion der Artikel Archiv/Darwin_Information_Typing_Architecture, Archiv/DITA_Single_Source_Publishing, Darwin_Information_Typing_Architecture.

wren

Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

Hallo,

ich habe einen Artikel erstellt indem beschrieben wird wie man sich eine DITA Single Source Publishing Umgebung einrichtet:

Darwin Information Typing Architecture

Gruß,
wren

noisefloor Team-Icon

Anmeldungsdatum:
6. Juni 2006

Beiträge: 29567

Hallo,

danke für den Artikel.

Ein paar Anmerkungen:
- Datei- und Verzeichnisnamen bitte immer fett
- Menüeinträge etc. bitte immer kursiv und in Anführungszeichen

Ansonsten bin ich verwirrt. Ich würde jetzt nicht behaupten, dass ich wirklich verstanden habe worum es geht oder wozu das wirklich gut ist.
Besonders die Einleitung hat mich voll überrannt.
Würd' mich mal interessieren, wie andere das sehen. ☺

Gruß
noisefloor

cornix Team-Icon

Avatar von cornix

Anmeldungsdatum:
9. März 2007

Beiträge: 4763

Wohnort: Ringenberg

Die topicorientiert strukturierte Einleitung erscheint mir auch suboptimal. ☺

DITA-Beispiel:

<topic id="DITA" xml:lang="DE-de">
   <title>DITA</title>
   <shortdesc>Die Darwin Information Typing Architecture (DITA) ist ein Dokumentenformat, ähnlich dem bekannten DocBook.</shortdesc>
      <body>
          <p>
          Die Darwin Information Typing Architecture (DITA) ist ein Dokumentenformat, ähnlich dem bekannten DocBook. DITA wird von der Firma IBM und OASIS als freie Architektur entwickelt und steht als definierte DTD kostenlos zur Verfügung. DITA basiert auf XML: im Gegensatz zum genannten DocBook gibt es für DITA keine SGML-basierte DTD... Langer Text...
          </p>
      </body>
</topic>

P.S.: Die angegebene Kategorie gibt es nicht.

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

noisefloor hat geschrieben:

Ein paar Anmerkungen:
- Datei- und Verzeichnisnamen bitte immer fett
- Menüeinträge etc. bitte immer kursiv und in Anführungszeichen

Danke für die Hinweise. Bin gerade beim Umziehen. Deshalb wird es einige Zeit dauern, bis ich die einarbeiten kann.

noisefloor hat geschrieben:

Ansonsten bin ich verwirrt. Ich würde jetzt nicht behaupten, dass ich wirklich verstanden habe worum es geht oder wozu das wirklich gut ist.
Besonders die Einleitung hat mich voll überrannt.

Meistens um die Wiederverwendung (Reuse) von Mini-Dokumentationen. So gibt es z.B. Funktionen in Firefox, Thunderbird und Sunbird die identisch sind. Und das über verschiedene Versionen hinweg. Die Dokumentationen für diese identischen Funktionen schreibt man einmal in einer Quelle (Single Source) und bindet sie dann mit einer Referenzmethode in die betreffende Dokumentation von Firefox, Thunderbird und Sunbird ein. Bei DITA geht es nicht um Copy&Paste und am Ende weiß niemand mehr so richtig welches das Original und wo das Orginal ist.

Es tut mir leid, daß die Einleitung so extrem kompakt ist. Der Artikel soll auch nur die Einrichtung der DITA Tools unter (Ubuntu) Linux beschreibe. Ansonsten kann ich wirklich nur auf die Literaturempfehlungen insbesondere die von Sissi Closs verweisen.

Entschuldigung, auf eine erneute Forendiskussion wie http://forum.ubuntuusers.de/topic/102759/ ab Zeitstempel 08.07.2007, 17:54 werde ich mich nicht mehr einlassen.

Gruß,
wren

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

@cornix

Das Einzige was DocBook und DITA gemeinsam haben ist der Single source publishing Gedanke. Ansonsten ist hier so gut wie gar nichts ähnlich.
DocBook ist hierarisch orientiert. Und gehört damit in die Mindmapping Ecke.
DITA produziert hierarisch losgelöste Informationseinheiten die sich beliebig miteinander kombinieren lassen und gehört in die Concept mapping Ecke.

cornix Team-Icon

Avatar von cornix

Anmeldungsdatum:
9. März 2007

Beiträge: 4763

Wohnort: Ringenberg

wren hat geschrieben:

Meistens um die Wiederverwendung (Reuse) von Mini-Dokumentationen. So gibt es z.B. Funktionen in Firefox, Thunderbird und Sunbird die identisch sind. Und das über verschiedene Versionen hinweg. Die Dokumentationen für diese identischen Funktionen schreibt man einmal in einer Quelle (Single Source) und bindet sie dann mit einer Referenzmethode in die betreffende Dokumentation von Firefox, Thunderbird und Sunbird ein. Bei DITA geht es nicht um Copy&Paste und am Ende weiß niemand mehr so richtig welches das Original und wo das Orginal ist.

Also im Prinzip so, wie march im Xfce-Bereich und bei den Menüs der verschiedenen Desktops sich wiederholende Abschnitte ausgelagert und mit Includes eingebunden hat - oder um ein kleineres Beispiel zu nehmen: wie bei den Warnungen vor Paketquellen.

wren, natürlich hat DocBook ein grundlegend anderes Konzept - an Hand von Unterschieden kann man IMHO sehr gut Vergleiche ziehen und der Text ist auch nicht von mir, sondern aus der Wikipedia. 😉

Onli Team-Icon

Ehemalige
Avatar von Onli

Anmeldungsdatum:
1. August 2005

Beiträge: 6941

Ich habe mal ein paar Kleinigkeiten der Formatierung repariert bzw angepasst. Keine Sorge, alles harmlose kleine Veränderungen, kenn mich mit dem Thema ja nicht aus.
Zur Einleitung:
Warum erklärst du es denn nicht auch im Artikel so schön verständlich, wie du es hier im Thread für noisefloor getan hast?
Imho wird die dort stehende Intellektuellenerklärung zusätzlich noch wesentlich unslesbarer durch die völlig unnötig Dopplung der Ansprache:

Damit der Lösungsvorschlag vom/von der Anwender/in nicht...

ist ja wohl mal wirklich unnötig. Wenn schon pseudo-korrekt, dann wenigstens den Anwender ins aktiv stellen: "Damit der/die Anwender/in den Lösungsvorschlag nicht..."
Ist aber hier unüblich, würd ich zum Anwender machen und gut ist.

Und: Müsste aus " DITA konforme Strukturierung" nicht DITA-konforme Strukturierung werden? Bin mir nicht ganz sicher, logisch scheint beides korrekt zu sein, ich bin an so Stellen aber ein paarmal gestolpert.

Dem Artikel fehlt außerdem ein Beispiel - ok, das ist kein Muss, wäre aber schön.
Gruß

noisefloor Team-Icon

Anmeldungsdatum:
6. Juni 2006

Beiträge: 29567

Hallo,

Beispiel +1 !

Gruß
noisefloor

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

cornix hat geschrieben:

wren hat geschrieben:

Meistens um die Wiederverwendung (Reuse) von Mini-Dokumentationen. So gibt es z.B. Funktionen in Firefox, Thunderbird und Sunbird die identisch sind. Und das über verschiedene Versionen hinweg. Die Dokumentationen für diese identischen Funktionen schreibt man einmal in einer Quelle (Single Source) und bindet sie dann mit einer Referenzmethode in die betreffende Dokumentation von Firefox, Thunderbird und Sunbird ein. Bei DITA geht es nicht um Copy&Paste und am Ende weiß niemand mehr so richtig welches das Original und wo das Orginal ist.

Also im Prinzip so, wie march im Xfce-Bereich und bei den Menüs der verschiedenen Desktops sich wiederholende Abschnitte ausgelagert und mit Includes eingebunden hat - oder um ein kleineres Beispiel zu nehmen: wie bei den Warnungen vor Paketquellen.

wren, natürlich hat DocBook ein grundlegend anderes Konzept - an Hand von Unterschieden kann man IMHO sehr gut Vergleiche ziehen und der Text ist auch nicht von mir, sondern aus der Wikipedia. 😉

zu XFCE kann ich jetzt erstmal spontan nichts sagen.

Stimmt, daß ist eine gute Idee. Ein kurzer Sachverhalt als Umsetzung mit DocBook und parallel mit DITA wäre verständlicher als die aktuelle (#6) schwerverdauliche Intellektuellenerklärung 😉

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

Onli hat geschrieben:

Zur Einleitung:
Warum erklärst du es denn nicht auch im Artikel so schön verständlich, wie du es hier im Thread für noisefloor getan hast?
Imho wird die dort stehende Intellektuellenerklärung zusätzlich noch wesentlich unslesbarer durch die völlig unnötig Dopplung der Ansprache:

Damit der Lösungsvorschlag vom/von der Anwender/in nicht...

ist ja wohl mal wirklich unnötig. Wenn schon pseudo-korrekt, dann wenigstens den Anwender ins aktiv stellen: "Damit der/die Anwender/in den Lösungsvorschlag nicht..."
Ist aber hier unüblich, würd ich zum Anwender machen und gut ist.

Okay. Wenn daß in der Wiki Policy so festgelegt ist. Ich bin zwar der Meinung daß "der/die Anwender/in usw." nicht den Lesefluß stört, wenn man sich paar Mal an das Prinzip gewöhnt hatte. Ich dachte nur wg. http://forum.ubuntuusers.de/topic/68320/75/ Zeitstempel 23.08.2007, 23:23 . Ich persönlich finde es unfair gegenüber Frauen. Bei den Berufen wird ja auch Wert auf die Hervorhebung gelegt. Z.B. Informationswirt/in . Zu Hinweisen im Vorwort eines Buches "... Alle Bezeichnungen in der männlichen Form beziehen sich auch auf Frauen..." kann ich nur den Kopf schütteln. Vielleicht mal eine Umfrage dazu starten?

Onli hat geschrieben:

Und: Müsste aus " DITA konforme Strukturierung" nicht DITA-konforme Strukturierung werden? Bin mir nicht ganz sicher, logisch scheint beides korrekt zu sein, ich bin an so Stellen aber ein paarmal gestolpert.
Gruß

"DITA-konforme Strukturierung" liest sich irgendwie besser.

Onli hat geschrieben:

Dem Artikel fehlt außerdem ein Beispiel - ok, das ist kein Muss, wäre aber schön.
Gruß

Okay.

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

noisefloor hat geschrieben:

Hallo,

Beispiel +1 !

Gruß
noisefloor

Verstehe ich nicht. Meinst du die Überschriften Hierarchie?

noisefloor Team-Icon

Anmeldungsdatum:
6. Juni 2006

Beiträge: 29567

Hallo,

nein - +1 heißt soviel wie "Zustimmung". ☺

Gruß
noisefloor

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

Habe noch mal nachgesehen, wie die Sissi das versucht darzustellen.

Vorläufiger Entwurf für eine leichter verdauliche Einleitung:

"... DITA ist ein XML Dialekt mit einer strikten Trennung von Inhalt und Layout Informationen.

Eine DITA-konforme Dokumentation besteht aus einer Vielzahl von hierarchiefreien Glossar-Einträgen, welche je nach Aufgabenstellung und Zielgruppe zur Zusammenstellung einer hierarisch orientierten Dokumentation zusammengestellt werden. Die inhaltlich zusammengestellte Dokumentation ist somit hierarchieorientiert.

Zuerst wird die Zielgruppe bestimmt. Dafür bieten sich sogenannte Use Cases an. In einer Art Brainstorming werden relevante Schlüsselwörter gesammelt bzw. später hinzugefügt. Hierbei ist "Mut zur Lücke" das Vorgehensprinzip. Danach werden diese zielgruppenrelevante Schlüsselwörter als Glossareinträge beschrieben. Nun könnte man die thematisch ähnliche Glossareinträge in inhaltlichen Klassen ordnen. Zur Verwaltung von einer Vielzahl von Glossareinträgen sind die Glossareinträge zwingend von einer Desktopsuche Software zu indexieren. Über diese Indexliste der Glossareinträge oder der Klassenzuordnung wird eine hierarische Glossarsammlung bzw. Dokumentation erstellt.
Um eine universelle Wiederverwendung von Glossarmodulen zu gewährleisten, ist bei der Zusammenstellung auf eine strikte Trennung von Wie (=Schritt-für-Schritt) & Was (=Hintergrundinformationen) Informationen zu achten. Dies ermöglicht die Zusammenstellung von zielgruppengerechter Dokumentation.

Nach der Herausbildung der inhaltlichen Struktur werden automatisch Layoutinformationen hinzugefügt. Beispiele dafür sind das PDF Format, die HTML Darstellung u.a.

DITA baut auf den bewährten Erfahrungen im Bereich des Datenbank-Design, der Objektorientierten Programmierung 🇩🇪 und der Technischen Dokumentation auf. Vor der Einarbeitung in das DITA Konzept sollten Strukturierungsfähigkeiten mit hierarisch orientierten Techniken wie z.B. dem Mind Mapping Mind Map 🇩🇪 trainiert werden. DITA konforme Strukturierung erfordert einen nicht unerheblichen Einarbeitungsaufwand. DITA ist ähnlich dem ODT u.ä. Office Format ein OASIS Standard..."

Die Sissi benutzt zur weiteren allgemeinverständlichen Erläuterung das Beispiel eines Eigentumhauses. Ich wäre für ein Beispiel mit dem Firefox Browser. Wer allerdings wirklich mit DITA arbeiten will muß sich irgendwo einlesen. Das DITA Wiki sollte sich eigentlich an Leute wenden, die schon wissen wozu DITA gut ist.

Ein durchdachtes Beispiel dafür bin ich noch schuldig. ☺

wren

(Themenstarter)
Avatar von wren

Anmeldungsdatum:
24. Juni 2007

Beiträge: 752

noisefloor hat geschrieben:

nein - +1 heißt soviel wie "Zustimmung". ☺

Ach so ☺

Gruß,
wren

cornix Team-Icon

Avatar von cornix

Anmeldungsdatum:
9. März 2007

Beiträge: 4763

Wohnort: Ringenberg

Ich habe das doch soweit richtig verstanden, dass das Konzept (unabhängig von der technischen Spezifikation), wie folgt umgesetzt wird:

Ich habe einen Artikel (ein Topic) erstellt, meinetwegen "Internetradio".
Ich habe mehrere Zielgruppen auf verschiedenen Ebenen, meinetwegen "Admin", "Mod" und "Listener" auf den Ebenen "Einsteiger" und "Fortgeschritten".

Jede der daraus resultierenden sechs Zielgruppen erhalten aus dem einen Artikel jeweils nur die an den Bedarf der Gruppe angepassten Informationen, aber im selben Design.

Richtig?

Antworten |