Hallo zusammen, Ich pflege einige Produktdokumentationen, welche ich vom ursprünglichen Verfasser "geerbt" habe. Dieser hat für alles MS Word benutzt. Nun ja, um einen Brief zu schreiben mag diese Software ganz brauchbar sein, für meinen Einsatzzweck ist es aber schlicht eine Zumutung. Wenn in mehreren Dokumenten gleiche Änderungen vorzunehmen sind (beispielsweise im Zuge eines erscheinenden Updates), dann stellt es für mich schon einen deutlichen Aufwand dar, sicherzustellen, dass das Layout nicht "verrutscht" usw. Außerdem ist dieses Herumgeklicke bestimmt zeitintensiver als ein Stück Quellcode aus einem Dokument zu kopieren und in ein anderes einzufügen. Hauptproblem ist, dass selbst Copy-And-Paste bei komplexen Tabellen usw. nicht korrekt funktioniert. Ruckzuck hat man eine neue Formatierung im Dokument, die man sich überhaupt nicht erklären kann. Ich würde mir ja wünschen, dass man Design und Inhalt getrennt definieren müsste und dann jedem Absatz zuweisen muss "Formatierung 1, 2 oder 3" usw. Das ist aber alles auf die einfachen Anwender ausgelegt, welche einen Satz oder nur ein Wort markieren und dann ganz schnell die Schriftart ändern wollen. Die .docx-Dateien lassen sich wunderbar einfach entpacken, die eigentliche XML-Datei, welche den Inhalt enthält, ist jedoch so zugemüllt, dass die Möglichkeit der externen Bearbeitung der Rohdaten entfällt. Für jeden Absatz werden beispielsweise sämtliche Formatierungen in den Attributen immer wiederholt. In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der "Corporate Identity" aus. Mathematische Formeln usw. benötige ich nicht. Dafür hätte ich jedoch eine einfache Textdatei, die ich frei bearbeiten könnte. Da ich normalerweise Entwickler bin und mit Quelltext arbeite, wäre mir eine "Low-Level"-Lösung am liebsten. (X)HTML und CSS wären an sich ja wunderbar, nur leider lässt dies keine Formatierung einzelner Seiten zu - ein umblätterbares Handbuch ist nun mal kein scrollbares Browser-Fenster. AbiWord hat ein wunderbares Dateiformat wie ich gesehen habe, welches sich auch problemlos außerhalb der Software editieren lässt, nur leider bestehen hier doch deutliche Funktionseinschränkungen in Vergleich zu MS Word (mit Vektorgrafiken kommt es beispielsweise überhaupt nicht klar). Mir wurde Adobe InDesign empfohlen - irgendwie erscheint mir das jedoch noch abschreckender zu sein als MS Word. Das ist zwar professionell, aber kommt man damit an die Rohdaten dran und falls ja, kann man die damit effizient manipulieren? Oder ist das auch komplett auf Klick, Klick, Klick ausgelegt? Diese Problemstellung mag zwar etwas speziell sein, aber ich frage mich, wie das Leute handhaben, welche das professionell erledigen müssen. Wie macht ihr denn so etwas? Ich kann es irgendwie nicht glauben, wieso es für die Textverarbeitung keine vergleichbaren Lösungen wie für die Website-Gestaltung gibt. Viele Grüße, Lars
Lars R. schrieb: > Ich würde mir ja wünschen, dass man Design und Inhalt getrennt > definieren müsste [...] > In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu > nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten > usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der > "Corporate Identity" aus. Schau dir mal LaTeX mit KOMA-Script an. https://www.rrzn.uni-hannover.de/fileadmin/kurse/material/latex/scrguide.pdf
Hallo Lars. Lars R. schrieb: > In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu > nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten > usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der > "Corporate Identity" aus. Schon einmal mit den Vorgesetzten gesprochen. ob sie in dem speziellen Falle nicht eine Ausnahme von dem "Corporate Identity" Quatsch machen können? Der Verweis auf Aufwand und Kosten kann oft verknöcherte Denkstruckturen lockern. Vieleicht geben sie sich ja mit einem gelegentlich eingefügten Logo zufrieden.;O) Ansonsten ist eigentlich LaTeX genau das was Du zu suchen scheinst, auch wenn ich es nicht als "Low Level" bezeichnen würde. > AbiWord hat ein wunderbares Dateiformat wie ich gesehen habe, welches > sich auch problemlos außerhalb der Software editieren lässt, nur leider > bestehen hier doch deutliche Funktionseinschränkungen in Vergleich zu MS > Word (mit Vektorgrafiken kommt es beispielsweise überhaupt nicht klar). Das heisst, Du suchst in Wirklichkeit doch KEINE "Low Level" Textverarbeitung. ;O) Schon einmal über HTML nachgedacht? Das Lässt sich auch im Editor erstellen. > Diese Problemstellung mag zwar etwas speziell sein, aber ich frage mich, > wie das Leute handhaben, welche das professionell erledigen müssen. Wie > macht ihr denn so etwas? Ich mache sowas nicht professionell. Aber was mir aufgefallen ist, ist, das Leute, die soetwas professionell bearbeiten, im allgemeinen den Inhalt von jemanden aderen bekommen, und sich dann nur noch über das Design Gedanken machen, nicht mehr über den Inhalt. Sie haben meist eine komplett andere Denkweise als ich, so das eine Kompatibilität nur schwer herstellbar ist. Mit freundlichem Gruß: Bernd Wiebus alias dl1eic http://www.dl0dg.de
:
Bearbeitet durch User
Lars R. schrieb: > In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu > nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten > usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der > "Corporate Identity" aus. Mathematische Formeln usw. benötige ich nicht. > Dafür hätte ich jedoch eine einfache Textdatei, die ich frei bearbeiten > könnte. > > Da ich normalerweise Entwickler bin und mit Quelltext arbeite, wäre mir > eine "Low-Level"-Lösung am liebsten. > > (X)HTML und CSS wären an sich ja wunderbar, nur leider lässt dies keine > Formatierung einzelner Seiten zu - ein umblätterbares Handbuch ist nun > mal kein scrollbares Browser-Fenster. Ok, ich werfe nochmal markdown mit anschließender HTML/PDF-Konversion in den Ring. Da hat man natürlich auch das HTML/CSS-Problem mit den einzelnen Seiten, aber man hat ein relativ einfach lesbares Quellformat. (Mit dem CSS kann man übrigens durchaus an bestimmten z.B. Überschriften den Anfang einer neuen Seite erzwingen) Das nutze ich für autogenerierte API-Dokumentation. Ist aber nicht unbedingt für alles passend. LaTeX nutzen wir hier in der Firma auch, hat natürlich den großen Vorteil, dass man es in Git packen kann. Mit xelatex ist es übrigens vergleichsweise einfach, normale Fonts zu verwenden. Man ist schon lange nicht mehr auf die mit metafont generierten Pixelvarianten der Computer-Modern-Fonts angewiesen. Viele Grüße, Simon
Hallo Bernd, Bernd Wiebus schrieb: > Das heisst, Du suchst in Wirklichkeit doch KEINE "Low Level" > Textverarbeitung. ;O) Doch schon, nur irgendeine Software muss später ja auch noch das PDF erzeugen. ;-) > Schon einmal über HTML nachgedacht? Das Lässt sich auch im Editor > erstellen. Ja, wie ich in meinem Eröffnungsbeitrag geschrieben habe, wäre mir das am liebsten. Nur ob das so gut für druckbare Seiten gedacht ist? Meine bisherigen Versuche mit XHTML und CSS haben mich leider an der Realisierbarkeit zweifeln lassen... > Ich mache sowas nicht professionell. Aber was mir aufgefallen ist, ist, > das Leute, die soetwas professionell bearbeiten, im allgemeinen den > Inhalt von jemanden aderen bekommen, und sich dann nur noch über das > Design Gedanken machen, nicht mehr über den Inhalt. Und die werden dann für jede Änderung erneut angeheuert? Und für dieselbe Sache x-mal bezahlt, weil es x Ausführungen des Dokuments gibt? Ich glaube diesen Vorschlag kann ich nicht bringen... Hallo Simon, Simon Budig schrieb: > Ok, ich werfe nochmal markdown mit anschließender HTML/PDF-Konversion in > den Ring. Da hat man natürlich auch das HTML/CSS-Problem mit den > einzelnen Seiten, aber man hat ein relativ einfach lesbares Quellformat. > > (Mit dem CSS kann man übrigens durchaus an bestimmten z.B. Überschriften > den Anfang einer neuen Seite erzwingen) > > Das nutze ich für autogenerierte API-Dokumentation. Ist aber nicht > unbedingt für alles passend. Dann werde ich es am besten doch nochmals damit versuchen. > LaTeX nutzen wir hier in der Firma auch, hat natürlich den großen > Vorteil, dass man es in Git packen kann. > > Mit xelatex ist es übrigens vergleichsweise einfach, normale Fonts zu > verwenden. Man ist schon lange nicht mehr auf die mit metafont > generierten Pixelvarianten der Computer-Modern-Fonts angewiesen. Das wäre dann wohl eine Alternative, die es zu testen gilt, wenn es mit HTML/CSS wieder nicht gelingen sollte. Viele Grüße, Lars
Docbook hat noch keiner genannt. Das ist auch ein XML-Format, das nachher mit entsprechenen Stylesheets in diverse Zielformate wie html oder pdf umgewandelt werden kann und das speziell für Handbücher entwickelt wurde.
Lars R. schrieb: > Hallo zusammen, > > Ich pflege einige Produktdokumentationen, welche ich vom ursprünglichen > Verfasser "geerbt" habe. Dieser hat für alles MS Word benutzt. Sei froh - stell dir vor der hätte dir ein undurchsichtiges, selbst geschriebenes LaTeX-Skript hinterlassen. > Nun ja, um einen Brief zu schreiben mag diese Software ganz brauchbar > sein, für meinen Einsatzzweck ist es aber schlicht eine Zumutung. Word-Bashing ist ja gerade in Technikerkreisen sehr beliebt. Mittlerweile ist das allerdings eine durchaus brauchbare Software. > Wenn in mehreren Dokumenten gleiche Änderungen vorzunehmen sind > (beispielsweise im Zuge eines erscheinenden Updates), dann stellt es für > mich schon einen deutlichen Aufwand dar, sicherzustellen, dass das > Layout nicht "verrutscht" usw. Außerdem ist dieses Herumgeklicke > bestimmt zeitintensiver als ein Stück Quellcode aus einem Dokument zu > kopieren und in ein anderes einzufügen. Dann ist wohl das Layout nicht so definiert wie es sein sollte. Dass sich Elemente verschieben lässt sich nicht vermeiden. > Hauptproblem ist, dass selbst Copy-And-Paste bei komplexen Tabellen usw. > nicht korrekt funktioniert. Ruckzuck hat man eine neue Formatierung im > Dokument, die man sich überhaupt nicht erklären kann. Vielleicht solltest du dich einmal mit Word beschäftigen und nächsten, warum sich die Formatierung ändert. Wenn du das weißt, dann kannst du das auch abstellen. > Ich würde mir ja wünschen, dass man Design und Inhalt getrennt > definieren müsste und dann jedem Absatz zuweisen muss "Formatierung 1, 2 > oder 3" usw. Das ist aber alles auf die einfachen Anwender ausgelegt, > welche einen Satz oder nur ein Wort markieren und dann ganz schnell die > Schriftart ändern wollen. Word lässt sich durchaus so verwenden wie du es beschreibst. Es soll sogar so (mit Formatvorlagen) verwendet werden. Sonst funktionieren ja auch automatische Verzeichnisse u.ä. nicht. Wenn du stattdessen alles manuell formatierst, dann wundert es mich ehrlich gesagt nicht, dass nichts ordentliches dabei heraus kommt. > Die .docx-Dateien lassen sich wunderbar einfach entpacken, die > eigentliche XML-Datei, welche den Inhalt enthält, ist jedoch so > zugemüllt, dass die Möglichkeit der externen Bearbeitung der Rohdaten > entfällt. Für jeden Absatz werden beispielsweise sämtliche > Formatierungen in den Attributen immer wiederholt. Wenn es sein muss, dann kannst du auch einmal ODF ansehen. Das ist sauberer, Standard und auch Word beherrscht es. > In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu > nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten > usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der > "Corporate Identity" aus. Mathematische Formeln usw. benötige ich nicht. > Dafür hätte ich jedoch eine einfache Textdatei, die ich frei bearbeiten > könnte. Ich dachte du möchtest Zeit sparen? > Da ich normalerweise Entwickler bin und mit Quelltext arbeite, wäre mir > eine "Low-Level"-Lösung am liebsten. > > (X)HTML und CSS wären an sich ja wunderbar, nur leider lässt dies keine > Formatierung einzelner Seiten zu - ein umblätterbares Handbuch ist nun > mal kein scrollbares Browser-Fenster. Die Idee hatte ich auch einmal, aber in Wirklichkeit ist das halt eher eine Technikerspielerei. > AbiWord hat ein wunderbares Dateiformat wie ich gesehen habe, welches > sich auch problemlos außerhalb der Software editieren lässt, nur leider > bestehen hier doch deutliche Funktionseinschränkungen in Vergleich zu MS > Word (mit Vektorgrafiken kommt es beispielsweise überhaupt nicht klar). Wäre ich dein Boss hätte ich keine Freude mit solchen Sonderlösungen. > Mir wurde Adobe InDesign empfohlen - irgendwie erscheint mir das jedoch > noch abschreckender zu sein als MS Word. Das ist zwar professionell, > aber kommt man damit an die Rohdaten dran und falls ja, kann man die > damit effizient manipulieren? Oder ist das auch komplett auf Klick, > Klick, Klick ausgelegt? Viel Einarbeitungszeit und auch nicht wirklich dafür gemacht. Dazu auch nicht unbedingt günstig. Kauft dir dein Chef so etwas einfach? > Diese Problemstellung mag zwar etwas speziell sein, aber ich frage mich, > wie das Leute handhaben, welche das professionell erledigen müssen. Wie > macht ihr denn so etwas? Technische Doku generiert man im Idealfall direkt aus dem Code, wird dann aber eher eine verlinkte HTML-Seite als ein Dokument. Userdoku und Designdokumente erstellen wir in Word. > Ich kann es irgendwie nicht glauben, wieso es für die Textverarbeitung > keine vergleichbaren Lösungen wie für die Website-Gestaltung gibt. Gibt schon einiges, aber ich denke wenn du dich ein bisschen mit Word beschäftigst (auch wenn es einfach aussieht ist es sehr komplex und belohnt, wenn man seine Bedienung erlernt) ist das für dich und die Firma wahrscheinlich die beste Lösung.
Lars R. schrieb: > In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu > nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten > usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der > "Corporate Identity" aus Es sollte möglich sein, TeX (und also auch LaTeX) mit anderen als den Metafont-Schriftarten zu nutzen. Zumindest mit Type1-Fonts ist das kein Problem: http://en.wikibooks.org/wiki/LaTeX/Fonts Und mit TrueType-Fonts geht das auch: http://fachschaft.physik.uni-greifswald.de/~stitch/ttf.html
Für Dokumentationen und sogar Rechnungen nutze ich nach wie vor LaTeX. Unter Windows gibt es das Paket http://miktex.org/
Lars R. schrieb: > In meiner Verzweiflung habe ich schon mit dem Gedanken gespielt LaTeX zu > nutzen, aber aufgrund der Einschränkungen (keine normalen Schriftarten > usw.) sähe das Ergebnis nachher eher wie eine Doktorarbeit anstelle der > "Corporate Identity" aus. Häh? Vielleicht schaust du noch ein zweites Mal. In (La)TeX kann man natürlich ein bestimmtes Aussehen des Ergebnisses erzwingen. Das ist doch der Sinn der ganzen Sache. Oder was glaubst du, wozu es die verschiedenen Dokumentklassen in LaTeX gibt? Und was meinst du mit "normale Schriftarten"? Adobe Type 1? Truetype? Kann (La)TeX alles. Das eigentliche Problem mit LaTeX dürfte sein, daß man eine Dokumenten- klasse nicht ganz so einfach zusammenklicken kann wie eine Vorlage in Word oder OO Writer. Muß man selber wissen, wieviel Aufwand einem das i.d.R. deutlich bessere Ergebnis und die später einfachere Handhabung von LaTeX wert sind. Im Zweifelsfall kommt man aber auch mit den Standard-Klassen wie Koma-Skript sehr weit, weil man da viele Stellschrauben hat, an denen man drehen kann (Schriftarten, Ränder, Abstände, etc) XL
Angehängte Dateien:
-
Screenshot.png
45 KB
Simon Budig schrieb: > Mit xelatex ist es übrigens vergleichsweise einfach, normale Fonts zu > verwenden. Siehe z. B. Anhang. Eine Gestaltung, die nicht von weitem nach Nerd¹ aussieht, ist damit einfach. Auch das Gefrickel mit Anführungszeichen etc. entfällt mit xelatex. Lars R. schrieb: > bei komplexen Tabellen Komplexe Tabellen sind in allen Latex-Varianten eine Qual. Wenn die häufiger vorkommen, würde das für mich Latex ausschließen. ¹Latexer sind die Veganer der Textverarbeitung...
Hallo Thomas, Thomas schrieb: > Komplexe Tabellen sind in allen Latex-Varianten eine Qual. Wenn die > häufiger vorkommen, würde das für mich Latex ausschließen. Was schlägst du stattdessen vor, wenn man um die Tabellen nicht herum kommt?
Hallo, ich muss auch mal kurz aus dem Off ein Vote für LaTex dazutun. Insbesondere wenn die Anleitungen modular aufgebaut sind ist das ein richitger Segen. Word heisst Word weil man damit Wörter und nicht Texte setzen kann. Für einen kurzen Blick auf Tabellen in LaTeX: http://www.suedraum.de/latex/stammtisch/degenkolb_tabellen.pdf Gerade rund um Tabellen gibt es eine wahre Fülle von Paketen, das suchen lohnt sich. Ansonsten (wenn CI eine und Geld keine Rolle spielen): Adobe FrameMaker. Cheers, Jan
Rolf Magnus schrieb: > Docbook hat noch keiner genannt. +1 für Dokumentation auf XML-Basis, also Docbook oder DITA. Ich verwende für technische Dokumente ausschließlich DITA. Mit der Latex-Syntax konnte ich mich noch nie anfreunden. Zudem kann ich leicht fremde Quellen per XSLT einbeziehen, z.B. die von Doxygen generierte API-Dokumentation als Anhang im fertigen Dokument, die Visual Studio XML Dokumentation ebenso. Als Framework verwende ich das OpenDita Toolkit (http://dita-ot.github.io/). Jan K. schrieb: > Ansonsten (wenn CI eine und Geld keine Rolle spielen): Adobe FrameMaker. Das ist wohl mehr oder weniger der Standard bei denen, die es sich leisten können. Ich würde es auch gerne mal ausprobieren (länger als 30 Tage). Die Software soll ebenfalls mit DITA recht gut können. Dann hätte ich bei der Migration dahin wohl die wenigsten Probleme.
Professionell arbeitende Firmen benutzen zur Produktdokumentation professionelle Werkzeuge. Mircosofts Wörd wuerde ich da nicht dazuzaehlen. Wenn es Geld kosten darf: Adobe Framemaker. Sieht man oft und gerne in den Properties von PDF-Dokumenten. Kann neben seinem eigenen Format auch mit XML umgehen oder MIF (Maker Interchange Format) und diverse andere Formate importieren. Aber auch damit gilt: Man muss fuer Formatvorlagen einigen Aufwand treiben.
Alexander B. schrieb: > Rolf Magnus schrieb: >> Docbook hat noch keiner genannt. > > +1 für Dokumentation auf XML-Basis, also Docbook oder DITA. Ich verwende > für technische Dokumente ausschließlich DITA. Mit der Latex-Syntax > konnte ich mich noch nie anfreunden. Alle Markup-Sprachen sind letztlich gleich mächtig. Allerdings liegt (La)TeX eher am konzisen Ende des Spektrums und XML weit(!) am geschwätzigen Ende. Und genau diese Geschwätzigkeit ist es, die mich stört (aus dem gleichen Grund mag ich auch Perl oder Ruby viel lieber als z.B. Java). Wenn es um (halb)automatisch generierte Dokumentation geht, dann spricht eigentlich alles für ein auf Einfachheit getrimmtes Format wie etwa Wiki, YAML oder ReST. Also etwas, das vor allem leicht zu schreiben ist, und halbwegs einfach zu parsen (weil man es für verschiedene Backends konvertieren wollen wird). XML kann dann ein Zwischenformat sein für z.B. das Web-Backend. Und LaTeX das Zwischenformat für PDF bzw. Druck. Allerdings sind die verfügbaren Toolchains eher was für Nerds denn für DAUs. Wenn man nicht die Bereitschaft zu Experimentieren, Lernen und notfalls auch selber mal Hand anlegen mitbringt, dann kommt man auf diesem Weg nicht weit. XL
Für genau solche Zwecke gibts Spezialsoftware, ist nur die Frage ob die in dein Budget passt. (keine Werbung, kenne die Firma weil die die selbe Kantine benutzen...) http://www.portamis.de
./. schrieb: > Wenn es Geld kosten darf: Adobe Framemaker. > Sieht man oft und gerne in den Properties von PDF-Dokumenten. > > Kann neben seinem eigenen Format auch mit XML umgehen oder > MIF (Maker Interchange Format) und diverse andere Formate importieren. Das werde ich mir mal näher ansehen. Die Produktbeschreibung von Adobe liest sich schon mal recht gut. Die 36 Euro pro Monat würden sich ja schon mehr als rechnen, wenn man damit nur einen Teil der Arbeit mit den Beschreibungen pro Monat einspart. Besonders gut gefällt mir, dass diese Software offenbar von Hause aus in der Lage ist mehrere Varianten durch Bedingungen zu verwalten (so wie ich das Handbuch verstehe). Vielen Dank für die Tipps.
Thread beobachten
Seitenaufteilung abschaltenBitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.