[FIAE] Ich schreibe meine Projektdokumentation in DocBook XML

[JavaBar]

Bei meiner letzten Abschlussprüfung war ich krank, ich kann sagen, zum Glück, denn meine Projektdokumentation war nicht so toll, und das Projekt nicht 100% fertig.

Das Schreiben der Projektdokumentation mit Word selbst war für eine Qual, Word machte, was es wollte, zerhaute mir ständig Schrift und Layout, und ich bin ein richtiger Word-Hasser geworden... Sorry, Bill Gates, aber für mich ist Word MÜLL.

Nun hab ich ein neues Projekt, und schreibe die Doc mit DocBook-XML, ein spezielles XML-Format für Bücher und Artikel.

Dessen XML-Syntax muss man erlernen, ähnlich wie man HTML erlernen muss.

Doch wenn man das beherrscht, es gibt auch ein paar gute Editoren für, kann man aus der XML-Datei ein PDF generieren. Oder mit einem XSLT-Prozessor ein HTML oder XHTML. Auch .chm-Dateien und andere Formate sind möglich.

Beim Erzeugen werden auch das Inhaltsverzeichnis richtig erstellt, Silbentrennung wird gemacht.

Es lassen sich auch Grafiken in bekannten Formaten einbetten, als Vektorgrafik wird SVG unterstützt. (EPS und WMF weiss ich jetzt noch nicht, muss ich probieren...)

Ich möchte anderen Fachinformatikern, speziell FIAE, empfehlen, sich mit Docbook und den Tools auseinanderzusetzen.

Wenn ich Zeit habe, arbeite ich selber an einem Guide für eine Projektdokumentation Docbook, bin aber selber noch am Forschen, Lernen und Probieren. Es macht Spass, im Gegensatz zu Word = Ärger.

Gibt es noch andere hier, die sich gerne für Docbook XML interessieren oder es verwenden?

Viele Grüße

Egon Schmid

In a world without walls and fences, we don't need windows and gates.

[flashpixx]

Tip: LaTeX ? Wikipedia

[JavaBar]

Tip: LaTeX ? Wikipedia

Ach ja, LaTeX gibt es auch noch. Das gab es schon lange (Anfangs der 80er) vor HTML (seit 1989)...

Ich möchte nicht unbedingt diskutieren, ob LaTeX oder DocBook-XML besser ist, zudem hab ich mich mit LaTeX mich zu wenig beschäftigt.

Ich interessiere mich für viel, probiere und lerne viel, aber alles muss man auch nicht wissen und können...

Gruß

Egon Schmid

[flashpixx]

DocBook ist zwar eine feine Sache, finde ich aber gerade bei längeren Sachen unschön, deshalb würde ich eher TeX nehmen. War ja nur ein Hinweis, vor allem weil Du ja möglichst "effizient" die Arbeit schreiben musst. Ich finde LaTeX z.B. mit SVN in Kobination sehr schön

[spix]

und ich bin ein richtiger Word-Hasser geworden... Sorry, Bill Gates, aber für mich ist Word MÜLL.

im Gegensatz zu Word = Ärger.

Kann ich nicht nachvollziehen. Ich hab meine Doku in Office 2010 geschrieben. War mir lieber als OpenOffice.

:floet:

[JavaBar]

@spix:

Damals, als ich die Doku (in Word 2003) schreiben musste, war ich unter Zeitdruck, und es war noch nichts geschrieben. Unter Zeitdruck läuft oft mehr schief.

Vielleicht war im .doc schon ein Fehler, jedenfalls ständig, beim Drücken von "Enter" oder "Backspace" änderte sich der ganze Block plötzlich wieder von Arial auf Times, oder bei einer Word-Grafik verschob Word ständig eine gezeichnete Linie.

Und wenn sowas ständig passiert, und man sowieso schon unter Zeitdruck ist, da ärgert man sich umso mehr.

Und dann was zu Office 2007: Ich weiss nicht, was sich Microsoft dabei gedacht hatte, das Ding in einem total anderen exotischen Layout zu präsentieren, wo sich keiner mehr zurechtfindet (Menüleiste verschwunden, und andere Dinge). Einige hier in unserem Betrieb sind gerade deswegen wieder auf 2003 zurück.

Und so ein Office-Paket ist auch nicht gerade billig. Das Geld würd ich eher in einen professionellen XML-Editor wie oXygen oder XMLSpy investieren.

Gruß

Egon Schmid

[georg33098]

ich empfehle LaTex.

[pruefer_gg]

Ich würde das Programm nehmen, mit dem man bereits vor dem Projekt am besten vertraut ist/ war. Extra für das AP ein neues Programm zu erlernen, halte ich für Risiko reich!

Ähnliches gilt übrigens auch für die Präsentation!

GG

[flashpixx]

Ich würde das Programm nehmen, mit dem man bereits vor dem Projekt am besten vertraut ist/ war. Extra für das AP ein neues Programm zu erlernen, halte ich für Risiko reich!

Das würde ich so nicht unterstützen, denn bevor ich tage- und nächtelang an der Doku arbeiten muss, weil mir das Wordfile zerstört wurde oder die Formatierung nicht richtig funktioniert, würde ich lieber den Aufwand investieren TeX zu lernen. TeX ist im Gegensatz zu MS Office für alle bekannten Plattformen erhältlich und vor allem aus dem Code wird immer das gleiche PDF generiert. Als weiteren Punkt, im Hinblick auf die Sicherheit, würde sich bei TeX ein SVN o.ä. anbieten, in das ich die Arbeit importiere, damit automatisiert eine Historie angelegt wird.

Rein vom Layout spricht es auch für LaTeX, denn der Satz ist besser, gerade wenn der Text im Blocksatz vorliegt, ebenso die Silbentrennung und die Darstellung von verschiedenen Schriftgrößen. Vergleicht man einen Grauert-Brief zwischen Word und TeX wird man auch eine gleichmäßigere Deckung feststellen (Ich denke mal für Docbook wird es ähnlich sein). Index, Glossar und Referenzierungstechniken (Footnote, Hyperref) sind bei TeX wesentlich umfangreicher als bei Word. Graphiken können z.B. direkt via PSTricks erstellt werden, ohne dass man noch eine weitere Software benötigt (optimal für Messwertanalysen oder Schemadarstellung).

Ich persönlich finde die Vorgaben der Kammer bezüglich der zu verwendeten Software eher suboptimal. Es wird sich oft an die MS Produkte fest geklammert. Mir sind inzwischen auch mehrere Kammern bekannt, wo ein Office Format erwartet wird. Was ich inzwischen eigentlich nicht tolerieren würde, denn womit man eine Arbeit verfasst, sollte einem selbst überlassen bleiben. Bei dem Zielformat sollte man sich eben auf PDF einigen. Ähnliches gilt für die Präsentation, auch die ist mit Hilfe der Beamerklassen unter TeX möglich.

Natürlich muss man LaTeX lernen, ebenso muss / musste man auch mal Word lernen. Innerhalb von zwei Tagen ohne Hilfe eine solche Arbeit in einem neuen Satzprogramm zu verfassen, ist denke ich schwierig, aber nicht unmöglich, da es neben den Newsgroups auch jede Menge Informationen im Netz gibt.

Es bleibt einem selbst überlassen, ich persönlich würde die Zeit während der Ausbildung nutzen, um mit für die Abschlussprüfung die TeX Kenntnisse anzueignen. Es erleichtert später die Arbeit doch erheblich