Dokumentation mit DocBook

Posts 1-10 of 10

Gerald Hirsch Premium Member
The company name is only visible to registered members.

Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Ich habe gerade mal eine kleine Umfrage gestartet, im welchem Umfang XML
bzw. DocBook in der Technischen Dokumentation heute eine Rolle spielt.
Unter Berücksichtigung der Tatsache, dass SGML bzw. DocBook speziell
für die Technische Dokumetation ausgelegt sind überrascht es mich ehrlich
gesagt, dass viele Unternehmen noch auf das proprietäre Dateiformat Word
auch in der technischen Dokumentation setzen. Die häufige Verwendung
von Tools wie z.B. DocToHelp, AuthorIT, RoboHelp und wie sie alle heissen
basieren alle mehr oder weniger auf dem Word-Format. Da frage ich mich
natuerlich, welche Gruende denn gegen einen Einsatz von XML bwz. DocBook
sprechen. Daher meine Frage, was hier im Forum unter den Fachleuten fuer eine Meinung herrscht. Desweiteren interessiert mich auch noch, welche
Tools sie zur Erstellung von DocBook-Dokumentatione am haeufigsten
benutzen, und was Sie evtl. auch weiterempfehlen können.
Ich bin schon gepannt auf Ihre Antworten!
Mit freundlichen Gruessen
Gerald Hirsch
- 23 Feb 2005, 09:59 am
Gerald Hirsch wrote: > Ich habe gerade mal eine kleine Umfrage gestartet, im welchem Umfang > XML > bzw. DocBook in der Technischen Dokumentation heute eine Rolle spielt. > Unter Berücksichtigung der Tatsache, dass SGML bzw. DocBook speziell > für die Technische Dokumetation ausgelegt sind überrascht es mich > ehrlich > gesagt, dass viele Unternehmen noch auf das proprietäre Dateiformat > Word > auch in der technischen Dokumentation setzen. Die häufige Verwendung > von Tools wie z.B. DocToHelp, AuthorIT, RoboHelp und wie sie alle > heissen > basieren alle mehr oder weniger auf dem Word-Format. Da frage ich mich > natuerlich, welche Gruende denn gegen einen Einsatz von XML bwz. > DocBook > sprechen. Daher meine Frage, was hier im Forum unter den Fachleuten > fuer eine Meinung herrscht. Desweiteren interessiert mich auch noch, > welche > Tools sie zur Erstellung von DocBook-Dokumentatione am haeufigsten > benutzen, und was Sie evtl. auch weiterempfehlen können. > Ich bin schon gepannt auf Ihre Antworten! > Mit freundlichen Gruessen > Gerald Hirsch
Lars Trieloff
The company name is only visible to registered members.

Re: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Hallo,

folgende Einwände habe ich bisher gegen den Einsatz von DocBook gehört:

- Die Umstellung ist zu aufwendig
- Mit unseren bestehenden Tools kommen wir gut zurecht
- XML ist zu kompliziert

Der letzte Punkt bezieht sich insbesondere auf den Fall, in dem man Kunden ein Dokument zur Begutachtung geben möchte, damit die Kunden Kommentare hinzufügen können. (Dies ist allerdings auch mit DocBook möglich, ohne dass die Kunden XML-Kenntnisse haben müssen)

Wenn man mit den bestehenden Tools zufrieden ist, wird man in der Regel sich nicht nach Alternativen umsehen, und daher nicht unbedingt auf DocBook stoßen.

Im Allgemeinen glaube ich, dass der Bekanntheitsgrad von DocBook und der Tools, die die Arbeit leichter machen nicht besonders hoch ist, und daher viele Firmen weiterhin mit Wordprozessoren Ihre Dokumentation erstellen.

Gerald Hirsch schrieb am 23.02.2005, 10:59:
Desweiteren interessiert mich auch noch, welche
Tools sie zur Erstellung von DocBook-Dokumentatione am haeufigsten
benutzen, und was Sie evtl. auch weiterempfehlen können.
Ich bin schon gepannt auf Ihre Antworten!
Mit freundlichen Gruessen
Gerald Hirsch
Ich benutze in meinen DocBook-Projekten neben einigen selbstgeschriebenen Tools (http://www.goshaky.com/) im wesentlichen den XMLmind XML Editor, jEdit, xsltproc, Saxon und RenderX XEP.
- 26 Feb 2005, 09:36 am
Lars Trieloff wrote: > Hallo, > > folgende Einwände habe ich bisher gegen den Einsatz von DocBook > gehört: > > - Die Umstellung ist zu aufwendig > - Mit unseren bestehenden Tools kommen wir gut zurecht > - XML ist zu kompliziert > > Der letzte Punkt bezieht sich insbesondere auf den Fall, in dem man > Kunden ein Dokument zur Begutachtung geben möchte, damit die Kunden > Kommentare hinzufügen können. (Dies ist allerdings auch mit DocBook > möglich, ohne dass die Kunden XML-Kenntnisse haben müssen) > > Wenn man mit den bestehenden Tools zufrieden ist, wird man in der > Regel sich nicht nach Alternativen umsehen, und daher nicht unbedingt > auf DocBook stoßen. > > Im Allgemeinen glaube ich, dass der Bekanntheitsgrad von DocBook und > der Tools, die die Arbeit leichter machen nicht besonders hoch ist, > und daher viele Firmen weiterhin mit Wordprozessoren Ihre > Dokumentation erstellen. > > Gerald Hirsch schrieb am 23.02.2005, 10:59: > > Desweiteren interessiert mich auch noch, welche > > Tools sie zur Erstellung von DocBook-Dokumentatione am haeufigsten > > benutzen, und was Sie evtl. auch weiterempfehlen können. > > Ich bin schon gepannt auf Ihre Antworten! > > Mit freundlichen Gruessen > > Gerald Hirsch > > Ich benutze in meinen DocBook-Projekten neben einigen > selbstgeschriebenen Tools (http://www.goshaky.com/) im wesentlichen > den XMLmind XML Editor, jEdit, xsltproc, Saxon und RenderX XEP.
Post visible to registered members
Post visible to registered members
Lars Trieloff
The company name is only visible to registered members.

Re^3: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Hallo Herr Stötefalke,

Dieter Stötefalke schrieb am 14.03.2005, 15:03:
Gerade im hochentwickelten Anlagenbau (Einzelfertigung) wird schnelle Reaktion in der Dokumentation erwartet.
um keine Mißverständnisse aufkomme zu lassen: Die Reaktionsfähigkeit der Dokumentationsabteilung ist in erster Linie eine Frage des Projektmanagements und der Dokumentationsprozesse und die Frage der gewählten Werkzeuge ist eher nachrangig.

Wenn die Benutzung der Werkzeuge klar ist, kann aus DocBook ohne größeren Aufwand das Zielformat erzeugt werden. Dieser Prozess ist auch automatisierbar.

viele Grüße

Lars Trieloff
- 14 Mar 2005, 5:48 pm
Lars Trieloff wrote: > Hallo Herr Stötefalke, > > > Dieter Stötefalke schrieb am 14.03.2005, 15:03: > > Gerade im hochentwickelten Anlagenbau (Einzelfertigung) wird > > schnelle Reaktion in der Dokumentation erwartet. > > um keine Mißverständnisse aufkomme zu lassen: Die Reaktionsfähigkeit > der Dokumentationsabteilung ist in erster Linie eine Frage des > Projektmanagements und der Dokumentationsprozesse und die Frage der > gewählten Werkzeuge ist eher nachrangig. > > Wenn die Benutzung der Werkzeuge klar ist, kann aus DocBook ohne > größeren Aufwand das Zielformat erzeugt werden. Dieser Prozess ist > auch automatisierbar. > > viele Grüße > > Lars Trieloff
Rainer Eschen Premium Member
The company name is only visible to registered members.

Re^2: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Editor: XMLMind XML Editor (XXE, http://www.xmlmind.com/xmleditor/)
Templates: docbook-xsl
Prozessor: xsltproc + ein selbstgeschriebenes Shell-Sript
PDF-Generierung: Java mit Apache FOP und Batik
An diesem Beispiel kann man schon gut erkennen, warum DocBook noch nichts ablösen konnte. Hier werden Technologien eingesetzt, mit denen man sich nicht wirklich abgeben möchte, wenn es *nur* um Dokumentation geht.

Ich habe auch mal einen Ansatz gewagt und mir einige der XML-Editoren mit DocBook-Auslegung angeschaut. Die kranken alle daran, daß sie aus der technischen Sicht geschrieben sind. Selbst die Werkzeuge von Altova (XML-Spy-Basis, wohl Marktführer) machen keinen Spaß. Ich setze XML-Spy zur Entwicklung ein, aber zur Dokumentation fehlt mir da noch was. Da würde ich lieber noch warten, bis OpenOffice und andere das XML-Schema für OpenDoc richtig verarbeiten können.

Gruß Rainer
- 22 May 2005, 02:18 am
Rainer Eschen wrote: > > Editor: XMLMind XML Editor (XXE, http://www.xmlmind.com/xmleditor/) > > Templates: docbook-xsl > > Prozessor: xsltproc + ein selbstgeschriebenes Shell-Sript > > PDF-Generierung: Java mit Apache FOP und Batik > > An diesem Beispiel kann man schon gut erkennen, warum DocBook noch > nichts ablösen konnte. Hier werden Technologien eingesetzt, mit denen > man sich nicht wirklich abgeben möchte, wenn es *nur* um > Dokumentation geht. > > Ich habe auch mal einen Ansatz gewagt und mir einige der XML-Editoren > mit DocBook-Auslegung angeschaut. Die kranken alle daran, daß sie aus > der technischen Sicht geschrieben sind. Selbst die Werkzeuge von > Altova (XML-Spy-Basis, wohl Marktführer) machen keinen Spaß. Ich > setze XML-Spy zur Entwicklung ein, aber zur Dokumentation fehlt mir > da noch was. Da würde ich lieber noch warten, bis OpenOffice und > andere das XML-Schema für OpenDoc richtig verarbeiten können. > > Gruß Rainer
Lars Trieloff
The company name is only visible to registered members.

Re^3: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Hallo,

An diesem Beispiel kann man schon gut erkennen, warum DocBook noch nichts ablösen konnte. Hier werden Technologien eingesetzt, mit denen man sich nicht wirklich abgeben möchte, wenn es *nur* um Dokumentation geht.
Es stimmt, dass die DocBook-Verarbeitung zur Zeit noch viele Werkzeuge erfordert, die nicht besonders intuitv zu benutzen sind und einen etwas höheren Einarbeitungsaufwand erfordert als klassische Textverarbeitungsprogramme. Dieser höhere Anfangsaufwand zahlt sich aber später durch gewonnene Flexibilität, Rationalisierungsmöglichkeiten und Automatisierbarkeit aus.

Ich habe auch mal einen Ansatz gewagt und mir einige der XML-Editoren mit DocBook-Auslegung angeschaut. Die kranken alle daran, daß sie aus der technischen Sicht geschrieben sind. Selbst die Werkzeuge von Altova (XML-Spy-Basis, wohl Marktführer) machen keinen Spaß. Ich setze XML-Spy zur Entwicklung ein, aber zur Dokumentation fehlt mir da noch was.
Als Alternative zu Altova Authentic kann ich den Editor Syntext Serna empfehlen. http://www.syntext.com/products/serna/ Dies ist einer der qualitativ besten WYSIWYG-Editoren, was die Dokumentansicht angeht.
- 22 May 2005, 9:47 pm
Lars Trieloff wrote: > Hallo, > > > > > An diesem Beispiel kann man schon gut erkennen, warum DocBook noch > > nichts ablösen konnte. Hier werden Technologien eingesetzt, mit denen > > man sich nicht wirklich abgeben möchte, wenn es *nur* um > > Dokumentation geht. > > Es stimmt, dass die DocBook-Verarbeitung zur Zeit noch viele > Werkzeuge erfordert, die nicht besonders intuitv zu benutzen sind und > einen etwas höheren Einarbeitungsaufwand erfordert als klassische > Textverarbeitungsprogramme. Dieser höhere Anfangsaufwand zahlt sich > aber später durch gewonnene Flexibilität, > Rationalisierungsmöglichkeiten und Automatisierbarkeit aus. > > > > > Ich habe auch mal einen Ansatz gewagt und mir einige der XML-Editoren > > mit DocBook-Auslegung angeschaut. Die kranken alle daran, daß sie aus > > der technischen Sicht geschrieben sind. Selbst die Werkzeuge von > > Altova (XML-Spy-Basis, wohl Marktführer) machen keinen Spaß. Ich > > setze XML-Spy zur Entwicklung ein, aber zur Dokumentation fehlt mir > > da noch was. > > Als Alternative zu Altova Authentic kann ich den Editor Syntext Serna > empfehlen. http://www.syntext.com/products/serna/ Dies ist einer der > qualitativ besten WYSIWYG-Editoren, was die Dokumentansicht angeht.
Henning Huber
The company name is only visible to registered members.

Re^4: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Lars Trieloff schrieb am 22.05.2005, 21:47:

Als Alternative zu Altova Authentic kann ich den Editor Syntext Serna empfehlen. http://www.syntext.com/products/serna/ Dies ist einer der qualitativ besten WYSIWYG-Editoren, was die Dokumentansicht angeht.
Hallo Lars,
mich würde mal interessieren wo der unterschied zwieschen dem Altova xmlSpy und dem Editor Syntext Serna ist. Auf dem ersten Bick würde ich sagen das die Produkte von Altova die Feature-Liste von Syntext Serna beinhaltet.

Ich habe selbst noch nicht mit Syntext Serna gearbeitet daher kann ich beide Editoren in ihrer Anwendung selbst nicht vergleichen.

MfG Henning
- 24 May 2005, 9:32 pm
Henning Huber wrote: > Lars Trieloff schrieb am 22.05.2005, 21:47: > > > Als Alternative zu Altova Authentic kann ich den Editor Syntext Serna > > empfehlen. http://www.syntext.com/products/serna/ Dies ist einer der > > qualitativ besten WYSIWYG-Editoren, was die Dokumentansicht angeht. > > Hallo Lars, > mich würde mal interessieren wo der unterschied zwieschen dem Altova > xmlSpy und dem Editor Syntext Serna ist. Auf dem ersten Bick würde > ich sagen das die Produkte von Altova die Feature-Liste von Syntext > Serna beinhaltet. > > Ich habe selbst noch nicht mit Syntext Serna gearbeitet daher kann > ich beide Editoren in ihrer Anwendung selbst nicht vergleichen. > > MfG Henning
Lars Trieloff
The company name is only visible to registered members.

Re^5: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!
Hallo Henning,

Syntext Serna ist im Gegensatz zu der kostenlosen Version von Altova Authentic (das ist der WYSIWYG-Editor, der im XMLSpy steckt) kostenpflichtig, daher ist diese Frage berechtigt.

Hallo Lars,
mich würde mal interessieren wo der unterschied zwieschen dem Altova xmlSpy und dem Editor Syntext Serna ist. Auf dem ersten Bick würde ich sagen das die Produkte von Altova die Feature-Liste von Syntext Serna beinhaltet.

Ich denke, dass Serna die beste WYSIWYG-Rendering-Qualität von allen XML-Editoren erreicht. Dadurch dass direkt XSL-FO auf dem Bildschirm angezeigt wird und XSLT zur Transformation benutzt wird, erscheint das Dokument fast genau so, wie es später gedruckt wird. Dies ist inbesondere bei nicht technisch versierten DocBook-Nutzern ein wichtiger Akzeptanzfaktor.

Da dieser Editor auch ausschließlich offene Standards wie XSLT und XSL-FO nutzt, können zum einen oft bestehende Stylesheets ohne großen Aufwand übernommen werden (wie es z.B. bei den DocBook-Stylesheets geschehen ist) und hilft dabei Kosten zu sparen. Oftmals ist es sogar möglich, die DocBook-Stylesheet-Anpassungen als Serna-Anpassungen zu verwenden.

Allerdings ist Syntext Serna kein guter XML-Editor was den Text-Modus angeht. Dort bietet er wenig mehr Hilfe als etwas Syntax-Highlighting und andere Editoren sind dort wesentlich mächtiger und flexibler. Aber für Autoren, die sich nicht mit allen XML-Feinheiten beschäftigen wollen, spielt das keine Rolle.

viele Grüße

Lars
- 24 May 2005, 11:52 pm
Lars Trieloff wrote: > Hallo Henning, > > Syntext Serna ist im Gegensatz zu der kostenlosen Version von Altova > Authentic (das ist der WYSIWYG-Editor, der im XMLSpy steckt) > kostenpflichtig, daher ist diese Frage berechtigt. > > > Hallo Lars, > > mich würde mal interessieren wo der unterschied zwieschen dem Altova > > xmlSpy und dem Editor Syntext Serna ist. Auf dem ersten Bick würde > > ich sagen das die Produkte von Altova die Feature-Liste von Syntext > > Serna beinhaltet. > > > Ich denke, dass Serna die beste WYSIWYG-Rendering-Qualität von allen > XML-Editoren erreicht. Dadurch dass direkt XSL-FO auf dem Bildschirm > angezeigt wird und XSLT zur Transformation benutzt wird, erscheint > das Dokument fast genau so, wie es später gedruckt wird. Dies ist > inbesondere bei nicht technisch versierten DocBook-Nutzern ein > wichtiger Akzeptanzfaktor. > > Da dieser Editor auch ausschließlich offene Standards wie XSLT und > XSL-FO nutzt, können zum einen oft bestehende Stylesheets ohne großen > Aufwand übernommen werden (wie es z.B. bei den DocBook-Stylesheets > geschehen ist) und hilft dabei Kosten zu sparen. Oftmals ist es sogar > möglich, die DocBook-Stylesheet-Anpassungen als Serna-Anpassungen zu > verwenden. > > Allerdings ist Syntext Serna kein guter XML-Editor was den Text-Modus > angeht. Dort bietet er wenig mehr Hilfe als etwas Syntax-Highlighting > und andere Editoren sind dort wesentlich mächtiger und flexibler. > Aber für Autoren, die sich nicht mit allen XML-Feinheiten > beschäftigen wollen, spielt das keine Rolle. > > viele Grüße > > Lars
Post visible to registered members

Dokumentation mit DocBook

Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!

Re: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!

Re^3: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!

Re^2: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!

Re^3: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!

Re^4: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!

Re^5: Gründe für die Nicht-Anwendung von DocBook in der Technischen Dokumentation!