Forum: PC Hard- und Software Programm zum erstellen eines Handbuches


Announcement: there is an English version of this forum on EmbDev.net. Posts you create there will be displayed on Mikrocontroller.net and EmbDev.net.
von Handbuch (Gast)


Lesenswert?

Moin,
ich hab die aufgabe bekommen für ein sehr sehr spezielles Programm ein 
Handbuch zu erstellen.
Inklusive experimentelle Überprüfung der Programmfunktionen und eben 
anschließende Anleitung zur Bedienung des Programmes.

Könnt ihr mir hierfür eine Anwendung empfehlen mit der sich das gut 
verwirklichen lässt?
 Mal abgesehen von word

Danke

von Nano (Gast)


Lesenswert?


von Urschleim Schleuder (Gast)


Lesenswert?

Hirn V1.0

ggf. vorher Schulung/Ausbildung: "Technische Dokumentation" 
installieren.

von LOL (Gast)


Lesenswert?

So sehr ich LaTeX Handbücher auch mag: Heutzutage würde ich sowas eher 
nicht mehr machen wollen, Doku ändert sich zu oft und die Pflege sollte 
kein Extra-Aufwand sein.

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

Oder irgendwas vergleichbares, was es a) ermöglicht einfach Text zu 
schreiben (wie LaTeX auch) und b) alle möglichen Ausgabeformate kann.

Falls das Programm im Quellcode vorliegt, kann man die Doku so gleich da 
reinbauen - eine alleinstehende Doku würde ich heute nicht mehr 
anfangen, geht damit aber auch.

Wenn es wirklich alleinstehend sein soll tut es auch irgend ein Wiki, so 
wie DokuWiki + ein brauchbarer PDF Export.

Vernünftige Online-Suche in Dokus ist IMHO ein muss, auch wenn man sich 
das Teil ggf. als Buch ausgeben lassen will.

von Hannes J. (Firma: _⌨_) (pnuebergang)


Lesenswert?

Da

* nicht mal die Zielformate (plural) genannt werden (gedrucktes 
Handbuch, Online-Help, Web-Documentation, E-Book, PDF, ...?), 
einschließen Formaten die man bei einer eventuellen Zertifizierung 
vorlegen müsste

* nichts über die benötigte Medienunterstützung (Zeichnungen aus 
CAD-Systemen, Illustrationen, Vektorgrafik, Pixelgrafik, Videos, 
Präsentationen, Animationen, interaktive Tutorials, ...?) gesagt wird

* nichts über speziell benötigte Funktionen (mathematisches Typesetting, 
Unterstützung für extrem lange Dokumente, Einbindungen von externen 
Quellen (wie Beispiel-Sourcecode oder eben CAD-Zeichnungen oder 
allgemein Database-Publishing), benötigte Sprachunterstützungen 
(Rechtschreibung, Grammatik), Übersetzerunterstützung, benötigte 
Template-Unterstützung, Zitat- und Quellenverwaltung, 
Dokumenten-Versionsverwaltung, paralleles Editieren, 
Review-Unterstützung, ...?) gesagt wird

* nichts über die Fähigkeiten und Vorbildung der Autoren gesagt wird

kann man eigentlich gar nichts sagen.

Außer vielleicht was zu TeX:

Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man 
nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten 
Scheiße aussehen darf.

: Bearbeitet durch User
von Andreas B. (bitverdreher)


Lesenswert?

Nano schrieb:
> Nutze LaTeX
>
> Als Programm kannst du TeXstudio nehmen:
+1

Hannes J. schrieb:
> das Ergebnis ansonsten
> Scheiße aussehen darf.
blubber! Keine Ahnung, aber mal was über Latex ablassen.

von Fichtel Sachs 3-Gang Torpedo (Gast)


Lesenswert?


von Molch (Gast)


Lesenswert?

Hannes J. schrieb:
> Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man
> nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten
> Scheiße aussehen darf.

Stimmt, darum sind ja auch die 1000-seitigen Springer-Wälzer in LaTeX 
gesetzt.

von Michael (Gast)


Lesenswert?


von high performer (Gast)


Lesenswert?

Ja, ganz toll.

Und nur 35 Euro pro Monat pro Benutzer.  Und HTML5 kann es auch. Da kann 
man es gleich als Bündel mit dem Adobe Flash Player anbieten.

Nicht so wie bei Tex-Dingsda. Da kriegst du sogar Geld, wenn du Quelcode 
nach Fehlern durchsuchst. Nix für Leute, die an 100k abkratzen.

von Georg (Gast)


Angehängte Dateien:

Lesenswert?

Handbuch schrieb:
> Mal abgesehen von word

Ein Handbuch ist zunächst mal ein Buch, und da ist alles hilfreich was 
in einem Buch so gebraucht wird - Kapiteleinteilung mit Überschriften, 
automatisches Inhaltsverzeichnis, automatischer Index, 
Fussnotenverwaltung usw. usw. Word ist schon seit den allerersten 
Anfängen berüchtigt dafür dass es zum Bücherschreiben herzlich 
ungeeignet ist.

Was man braucht ist eine Desktop Publishing Software, da gibt es viele 
schon seit sehr langer Zeit. Ich habe Handbücher mit dem Ventura 
Publisher geschrieben, echtes Urgestein, und war sehr zufrieden, bloss 
wurde der ein paar mal verkauft und dadurch ruiniert und dann 
eingestellt. Eine Beispielseite anbei.

Als noch aktueller Publisher wurde hier Framemaker genannt. Die 
Beschreibung der Software oder auch von was ganz anderem muss man sich 
schon selber ausdenken, soweit ist die KI noch nicht dass sie aus einem 
Computerprogramm automatisch ein schickes Handbuch erstellt.

Georg

von Markus (Gast)


Lesenswert?

Es gibt durchaus Handbücher, die in Word geschrieben sind und in 
Leitzordnern bereitgestellt werden. Mittlerweile kann man bei Word 
Überschriften verwenden. Es ist sogar möglich, einzelne Kapitel in 
unterschiedlichen Dateien zu speichern, falls es zu umfangreich werden 
würde. Es gibt sogar einen Formeleditor, mit dem man auch komplexere 
mathematische Ausdrücke darstellen kann, ganz wie mit TeX. Für 
Handbücher gibt es profesionelle Software, die Geld kostet, die 
Einarbeitung kostet Zeit. Ebenfalls kostet es Zeit die Anforderungen an 
ein ordentliches Handbuch kennen zu lernen. Profis haben die Software 
und die Kenntnisse. Also: make or buy?

von Dieter (Gast)


Lesenswert?

Handbuch schrieb:
> Mal abgesehen von word

Latex wurde schon genannt.

Libre Office kannst Du nehmen um alles Whyswing zu bearbeiten.

von Nano (Gast)


Lesenswert?

Georg schrieb:
> Was man braucht ist eine Desktop Publishing Software,

Nein!

Er will ein Buch schreiben und sich nicht stundenlang mit dem Layouten 
von Seiten Zeit verschwenden.
Eine Desktop Publishing Software (DTP) ist okay für die Titelseite von 
Printmedien, sowie für Werbeflyer und Werbung allgemein, aber zum Bücher 
schreiben ist das nicht geeignet.
Was er machen kann ist seinen Text in eine DTP Software einfügen, 
nachdem er den gesamten Text für das Handbuch geschrieben hat, aber 
nicht vorher.

Und hier kommt TeX als haushoch Überlegen ins Spiel.
Damit kann man sich nämlich erst einmal auf das reine Schreiben des 
Textes konzentrieren und sich um das Layouten dann später kümmern.

von Nano (Gast)


Lesenswert?

Molch schrieb:
> Hannes J. schrieb:
>> Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man
>> nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten
>> Scheiße aussehen darf.
>
> Stimmt, darum sind ja auch die 1000-seitigen Springer-Wälzer in LaTeX
> gesetzt.

Sowie die ganzen Bücher von Addison-Wesley und der Pearson Studium Reihe 
aus dem Pearson Verlag.

von oerks (Gast)


Lesenswert?


von TomA (Gast)


Angehängte Dateien:

Lesenswert?

Hallo Handbuch!

Ich verwende für solche Dinge den LibreOfficeWriter. Damit lassen sich 
Bilder und Texte aus unterschiedlichen Quellen einfach zusammenstellen 
und bearbeiten.

Als Beispiel das Handbuch eines kleinen Editors.

Gruss Tom.

von Georg (Gast)


Lesenswert?

Nano schrieb:
> Eine Desktop Publishing Software (DTP) ist okay für die Titelseite von
> Printmedien, sowie für Werbeflyer und Werbung allgemein

Offensichtlich kennst du kein DTP-Programm.

Georg

von Andreas F. (andgset)


Lesenswert?

Hannes J. schrieb:
> Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man
> nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten
> Scheiße aussehen darf.

Was für ein dummes Geschwätz. Mit minimal Ahnung von der Materie wirst 
du feststellen dass die meisten Fachbücher, unabhängig von der 
Fachrichtung in LaTex gesetzt sind. Ahnung hast du aber offensichtlich 
nicht.

von Karl (Gast)


Lesenswert?

Ich würde Lyx nehmen, baut auf LaTeX auf ist aber etwas handlicher. Bei 
umfangreichen Dokumenten, die man über Jahre pflegt ist man mit Latex 
auf der sicheren Seite. Bei Word kommt dann irgendwann "Fehler, Verweis 
nicht gefunden" raus. Lyx/Latex bietet z.B. auch die Möglichkeit die 
Bildgröße anhand der Textspaltenbreite festzulegen. D.h. man kann das 
Seitenformat / Seitenränder beliebig ändern und bekommt trotzdem ein 
sauberes Ergebnis (wenn das Dokument ordentlich angelegt ist).

von Hannes J. (Firma: _⌨_) (pnuebergang)


Lesenswert?

Molch schrieb:
> Hannes J. schrieb:
>> Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man
>> nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten
>> Scheiße aussehen darf.
>
> Stimmt, darum sind ja auch die 1000-seitigen Springer-Wälzer in LaTeX
> gesetzt.

Lustig wie die ganzen TeX-Fanboys kotzen, Äpfel mit Birnen vergleichen 
(ein Handbuch ist kein Lehrbuch) und sich dann was zusammenlügen. Man 
kann euch immer so schön am Nasenring durch die Arena führen weil ihr 
immer noch der akademischen TeX-Propaganda aus den 80ern glaubt.

Springer verwendet ein XML-Format, das sie unter anderem aus 
eingereichten Word- und LaTeX-Dokumenten generieren können.

Also doch TeX? Nicht ganz. Sie schmeißen den Formatier-Müll, auf den die 
Fanboys so stehen, weil er die einzigartige TeX-Hässlichkeit erzeugt, 
weg. Nur die Element-Auszeichnung wird genommen. Das sie TeX überhaupt 
akzeptieren ist ein Zugeständnis an in der Vergangenheit 
stehengebliebene Akademiker.

Nichts von wegen "in LaTeX gesetzt". Gerade der Satz wird nicht von 
LaTeX genommen. Es soll ja nach etwas aussehen das man verkaufen kann.

von Andreas (Gast)


Lesenswert?

Eventuell gibt es für Open Office eine Vorlage die eine Handbuchstruktur 
berücksichtigt.

von ●DesIntegrator ●. (Firma: FULL PALATINSK) (desinfector) Benutzerseite


Lesenswert?

wenn man Sätze vermeidet wie

"Jetzt schliesst man sich an den USB-Port an"

ist schon viel gewonnen!

von J.D. (Gast)


Lesenswert?

Hannes J. schrieb:
> Molch schrieb:
>> Hannes J. schrieb:
>>> Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man
>>> nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten
>>> Scheiße aussehen darf.
>>
>> Stimmt, darum sind ja auch die 1000-seitigen Springer-Wälzer in LaTeX
>> gesetzt.
>
> Lustig wie die ganzen TeX-Fanboys kotzen, Äpfel mit Birnen vergleichen
> (ein Handbuch ist kein Lehrbuch) und sich dann was zusammenlügen. Man
> kann euch immer so schön am Nasenring durch die Arena führen weil ihr
> immer noch der akademischen TeX-Propaganda aus den 80ern glaubt.
>
> Springer verwendet ein XML-Format, das sie unter anderem aus
> eingereichten Word- und LaTeX-Dokumenten generieren können.
>
> Also doch TeX? Nicht ganz. Sie schmeißen den Formatier-Müll, auf den die
> Fanboys so stehen, weil er die einzigartige TeX-Hässlichkeit erzeugt,
> weg. Nur die Element-Auszeichnung wird genommen. Das sie TeX überhaupt
> akzeptieren ist ein Zugeständnis an in der Vergangenheit
> stehengebliebene Akademiker.
>
> Nichts von wegen "in LaTeX gesetzt". Gerade der Satz wird nicht von
> LaTeX genommen. Es soll ja nach etwas aussehen das man verkaufen kann.

Sagen Sie dass mal der IEEE...

https://books.ieeeauthorcenter.ieee.org/prepare-your-book-manuscript/book-templates/
https://www.ieee.org/conferences/publishing/templates.html

von Tintenkiller (Gast)


Lesenswert?

Da hier oft das Thema "Formatierung bei TeX/LateX" genannt wird: Es 
verhält sich dabei so wie bei HTML/CSS.

Eine Website in plain HTML schaut erst mal grässlich aus, wenn man sich 
aber die Mühe macht und ein ordenliches CSS-Stylesheet erstellt, kann 
etwas wunderschönes dabei rauskommen.

So auch bei Tex-gesetzen Dokumenten. Ohne weitere Formattierungen sehen 
mit mit Latex erstellte Dokumente erst mal verdammt schlecht aus.
Mann kann, (wenn man sich die Mühe macht) allerdings jede noch so kleine 
Kleinigkeit einstellen. Vom Zeilenabstand, über die Seitenränder, 
Zeichenabstand usw. usf. Daher stellen wiele Publisher (wie oben genannt 
die IEEE) eigene Latex-Vorlagen zur Verfügung, oder machen diebezüglich 
exakte Vorgaben 
(https://static.springer.com/sgw/documents/1365881/application/pdf/Hinweise_Manuskripterstellung.pdf)

Der größte Vorteil von Latex-Dokumenten ist allerdigs die Quelloffenheit 
der Tex/Latex/...*tex Spezifikationen und der gängigen Compiler. Und da 
die meisten Dokument-Quellcodes einfache ASCII-Dateien sind, kann man 
diese auch noch in 20+ Jahren öffnen und bearbeiten, was sich in der 
Vergangenheit bei z.B. Word ja durchaus als Problem dargestellt hat.

Das z.B. Spinger ein eigenes XML-Formal verwendet ist jetzt auch kein 
Argument gegen Latex, da es ja eigentlich Sinn macht Autoren möglichst 
große Freiheiten zu geben WIE sie ihre Werke schreiben, und dann alles 
firmen-intern auf ein eigenes Format zu übersetzen.

Wie man jetzt ein "Handbuch" schreibt hängt mMn vom verwendeten Inhalt 
ab.
Wenn das Dokument eher wissenschaftlicher/technische Natur ist (viel 
Mathe, eher weniger Text) dann ist Latex sicher eine gute Wahl, zumal 
man sich dann auch nicht in die Fänge von DTP-Software Anbietern gibt.

von Karl (Gast)


Lesenswert?

Hannes J. schrieb:
> Gerade der Satz wird nicht von
> LaTeX genommen. Es soll ja nach etwas aussehen das man verkaufen kann.

Welche Qualifikation hat der Herr den vorzuweisen, um zu bewerten, ob 
der Textsatz von Tex gut ist oder nicht? Es steht wohl zweifelsfrei 
fest, das er besser als von Word und Writer ist, was evtl. die 
Alternativen wären.

Wenn man sich auskennt geht das erstellen von und ändern von 
(umfangreichen) Textdokumenten in Latex halt erheblich schneller. Ein 
Bild in Latex tauschen? Bild mit dem Bearbeitungsprogramm bearbeiten in 
den Zielordner exportieren fertig. Bild in Word tausch Bild mit dem 
Bearbeitungsprogramm bearbeiten, exportieren, In Word das Bild suchen, 
rechtsklick machen, Bild ändern klicken, Dateipfad suchen, Datei 
auswählen,  und O.K. klicken. Wenn man 20 Bilder gleichzeitig ändern 
will, merkt man den Vorteil. Wenn man ein Freund der stupiden Klickerei 
ist, dann ist man bei Word richtig.

von Karl (Gast)


Lesenswert?

J.D. schrieb:
> https://www.ieee.org/conferences/publishing/templates.html

An der Word-Vorlage sieht man mal wieder, dass 99,9 % der Word-Nutzer es 
nicht hinbekommen eine Ordentliche Word-Vorlage zu erstellen. Wenn man 
den Fließtext in die Formatvorlage Standard setzt, wird er zentriert 
dargestellt. Deshalb schaffen es auch 99,99 % der Wordbenutzer nicht ein 
Textdokument "aus einem Guss" zu produzieren.

von oerks (Gast)


Lesenswert?

Bei Word kommt ja hinzu, dass die gesetzten Defaults der
Standardvorlage fuer ein schlechtes Schriftbild sorgen.
Z.B. ist bei denen das Kerning immer ausgeschaltet.
Aber wenn man es vermeiden kann, sollte man Word wirklich
nicht fuer Dokumentationen verwenden.

Das Beispiel mit den Bilder(-Austausch) funktioniert
auch mit Framemaker, wenn man die Bilder nur per Referenz
einbindet.

von Nano (Gast)


Lesenswert?

Georg schrieb:
> Nano schrieb:
>> Eine Desktop Publishing Software (DTP) ist okay für die Titelseite von
>> Printmedien, sowie für Werbeflyer und Werbung allgemein
>
> Offensichtlich kennst du kein DTP-Programm.
>
> Georg

Dann ist deine Glaskugel kaputt.
Kauf dir ne neue.

Von QuarkXPress hast du bestimmt nichts gehört.

von Nano (Gast)


Lesenswert?

Tintenkiller schrieb:
> Und da
> die meisten Dokument-Quellcodes einfache ASCII-Dateien sind,

Inzwischen UTF-8

Der Rest ist korrekt.

von Nano (Gast)


Lesenswert?

Karl schrieb:
> Hannes J. schrieb:
>> Gerade der Satz wird nicht von
>> LaTeX genommen. Es soll ja nach etwas aussehen das man verkaufen kann.
>
> Welche Qualifikation hat der Herr den vorzuweisen, um zu bewerten, ob
> der Textsatz von Tex gut ist oder nicht? Es steht wohl zweifelsfrei
> fest, das er besser als von Word und Writer ist, was evtl. die
> Alternativen wären.

Hannes redet mal wieder Müll.
LaTeX hat vorgegebene Satzdaten, die in TeX geschrieben sind.
Die muss man aber nicht nutzen. Viele Verlage haben ihre eigenen 
Satzdaten, die aber alle in bzw. für TeX geschrieben sind.

von Georg (Gast)


Lesenswert?

Nano schrieb:
> Dann ist deine Glaskugel kaputt.
> Kauf dir ne neue.

Was für ein sachliches Argument.

Dass ein Programm für Flyer geeignet ist beweist ja nicht, dass es für 
etwas anderes wie etwa ein Handbuch nicht geeignet sein kann. Wofür 
glaubst du braucht man bei einem Flyer eine Funktion zum automatischen 
Erstellen eines Inhaltsverzeichnisses? Usw. usw.

Georg

von oerks (Gast)


Lesenswert?

> Von QuarkXPress hast du bestimmt nichts gehört.

Damit werden die "Sankt Pauli Nachrichten" gesetzt.
Dokumentation ist schon noch etwas anderes.

von Walter K. (walter_k488)


Lesenswert?

Natürlich LaTex … und als Editor empfehle ich vim - Für vim gibt es 
übrigens jede Menge Plugins für LaTex.
Wenn Du Dich da mal eingearbeitet hast, wirst Du nichts anderes mehr 
wollen - auch wenn der Beginn etwas steinig ist.

von lexi (Gast)


Lesenswert?

Ich komme mit LaTeX einfach nicht klar... Ich kann AsciiDoc empfehlen 
(https://asciidoc.org/). Ist zwar nicht so mächtig wie LaTeX, aber für 
vieles absolut ausreichend.

von Albert A. (Gast)


Lesenswert?

Ich werfe hier mal Scrivener 3 ein.

Scriver ist gemacht für Buchautoren und extrem lange Texte mit Bildern.
Text-Ablage System (Text Schnipsel) etc., diversere Ausgabeformate incl. 
pdf oder ePub.

https://www.literatureandlatte.com/introducing-scrivener-3-for-windows


oder auch:


Papyrus Autor 11

https://www.papyrus.de/?gclid=CjwKCAjwsNiIBhBdEiwAJK4khuZrPnKguPYwZq9jrCuSvX64Nh2ERdZ4rpPlQXfgtL96d_IytPnxBhoCTNgQAvD_BwE

von Εrnst B. (ernst)


Lesenswert?

scribus wurde noch nicht genannt.

https://www.scribus.net/category/made-with-scribus/

von Urschleim Schleuder (Gast)


Lesenswert?


von Nano (Gast)


Lesenswert?

oerks schrieb:
>> Von QuarkXPress hast du bestimmt nichts gehört.
>
> Damit werden die "Sankt Pauli Nachrichten" gesetzt.
> Dokumentation ist schon noch etwas anderes.

Georg hält DTP bestens geeignet zum Erstellen von Dokumentation.

von Nano (Gast)


Lesenswert?

Georg schrieb:
> Nano schrieb:
>> Dann ist deine Glaskugel kaputt.
>> Kauf dir ne neue.
>
> Was für ein sachliches Argument.

Ne, du bist da einfach selbst schuld.
Wenn du mir unterstellst, dass ich noch nie ein DTP Programm gesehen 
habe, aber QuarkXPress kenne, was nachweislich ein DTP Programm ist, 
dann kennst du
1. QuarkXPress nicht
und
2. ist deine Glaskugel kaputt


> Dass ein Programm für Flyer geeignet ist beweist ja nicht, dass es für
> etwas anderes wie etwa ein Handbuch nicht geeignet sein kann.

Du kannst auch mit einem Texteditor deine Tabellen erstellen und dann 
mit
dem Taschenrechner die Spaltenergebnisse ausrechnen.
Trotzdem ist das völliger Unsinn und so verhält es sich auch mit DTP 
Programme, weil die in erster Linie zum Layouten da sind und nicht zum 
schreiben eines Handbuchs.
Man kann es also auch umständlich machen oder man macht es effizient und 
nimmt gleich irgendwas TeX basiertes oder vergleichbares.

> Wofür
> glaubst du braucht man bei einem Flyer eine Funktion zum automatischen
> Erstellen eines Inhaltsverzeichnisses? Usw. usw.

Weil es auch Playboy Magazine gibt. Aber da geht's auch um das Layouten.
Den Inhalt der Artikel schreibt man mit etwas anderem und fügt es am 
Ende dann ins DTP Programm ein.

von MaWin (Gast)


Lesenswert?

Latex, Word und co ist für Idioten, richtige Profis verwenden Paint.

von W.S. (Gast)


Lesenswert?

Nano schrieb:
> Weil es auch Playboy Magazine gibt.

Nun, hier geht es nicht um das Präsentieren von anregenden Posen etc. - 
sondern um das Verfassen von Dokumentationen, da geht eigentlich jede 
heutige Bürosuite aus Textverarbeitung, Tabellenkalkulation und 
Präsentations-Programm.

Der TO hat bei mir eher den Eindruck gemacht, daß er sich um das eigene 
Denken und den Sachbezug herumdrücken will. Etwa so, wie es diverse 
Prorammiereriche meinen, die sowas wie Doxygen über ihre Quellcodes 
hinweg jagen und erwarten, daß damit eine Dokumentation bei herauskommt.

Irgend ein Zeug, wo sowas wie die Prozedur/Funktions-Köpfe in bunt und 
wählbaren Font-Schnitten kommt tatsächlich dabei heraus.

Aber sowas ist von einer Dokumentation soweit entfernt wie die Kuh vom 
Mond. Nein, es geht nicht ohne den (hoffentlich vorhandenen) eigenen 
menschlichen Verstand und das eigene Durchsehen und Verstehen des 
Ganzen. Und ein Stück der eigenen Mühe.

W.S.

von ●DesIntegrator ●. (Firma: FULL PALATINSK) (desinfector) Benutzerseite


Lesenswert?

MaWin schrieb:
> Latex, Word und co ist für Idioten, richtige Profis verwenden Paint.

Paint-Bilder lassen sich von vielen Programmen anzeigen.

bei "Word" ist man sich ja schon gerne mal nicht selbst treu.

von Zeno (Gast)


Lesenswert?

Hannes J. schrieb:
> Praktisch niemand verwendet TeX im kommerziellen Umfeld. TeX nimmt man
> nur wenn es um einen Haufen Mathematik geht und das Ergebnis ansonsten
> Scheiße aussehen darf.
Das zeigt, das Du wenig bis gar keine Ahnung von TeX hast.
Gerade wenn es gut aussehen soll nimmt TeX. Das ist halt ein 
ordentliches Satzsystem und Ende passen die Ränder, 
Kapitelnummerierungen, Abbildungsnummerierungen etc.. Die Lernkurve bei 
TeX ist halt etwas steiler und die Arbeitsweise ist erst mal ungewohnt. 
Wenn man sich aber erst mal daran gewöhnt hat möchte man keine Doku mehr 
mit Word und Konsorten schreiben. Für die grundlegenden Sachen hat TeX 
Vorlagen, die man benutzen kann (am Anfang zu empfehlen) aber nicht muß. 
Ich habe am Anfang die Vorlagen genutzt und dann immer mehr mein eigenes 
Zeug gemacht. Gute Tutorials gibt es im Netz.
Unter Windows arbeite ich am liebsten mit TeXnicCenter. Es gibt noch 
TeXstudio und TeXworks (Bestandteil von MikTeX).

Wenn es am Ende 'ne Hilfedatei werden soll, dann ist TeX natürlich nicht 
das Mittel der Wahl. Für PDF bzw. gedruckte Sachen ist es aber sehr gut.

von Zeno (Gast)


Lesenswert?

TomA schrieb:
> Ich verwende für solche Dinge den LibreOfficeWriter. Damit lassen sich
> Bilder und Texte aus unterschiedlichen Quellen einfach zusammenstellen
> und bearbeiten.
Ja am Ende sieht man es dem Dokument halt auch an, es es mit einem 
Officeprogramm erstellt wurde.
Nichts gegen Deine Arbeit, weil es sieht ja dennoch ordentlich aus - die 
meisten schaffen es ja noch nicht mal ein Handbuch zu erstellen.
Dennoch sieht es am Ende mit einem Satzsystem besser aus - mußte ich 
auch erst lernen.

von Joe G. (feinmechaniker) Benutzerseite


Lesenswert?

Auch wenn Word, warum auch immer, einen schlechten Ruf als Satz und 
Layoutprogram hat, hier ein Link für Layoutvorlagen, welche ich selber 
gerne verwende.
https://buchlayout.info/satz-und-layout/word-vorlagen-fuer-selfpublisher/

von Thomas R. (analogfreak)


Lesenswert?

EMACS org-mode.
Hat u.A. guten LaTeX-Export.

von Schlaumaier (Gast)


Lesenswert?

Handbücher sind so was von OUT.

Heutzutage nutzt man Hilfs-Systeme. Entweder Online oder z.b. das 
MS-Hilfe-System.

Der Grund ist einfach.  Handbücher veraltern schnell. Und man muss 
Ewigkeiten suchen.  Selbst wenn es ein gutes Index-System hat (was sehr 
selten ist) stehen da nicht alle Suchbegriffe drin.

Wenn ich Hilfe brauche such ich nach den Schlüsselwort und schaue nach 
ob der Text darin mein Problem beschreibt.

Bei PDF mit STRG-F  oder halt Suche bei MS-Hilfs-System. (F1-Taste meist 
zum aufrufen).

Also. Vergiss das Handbuch. Mache ein gescheites Hilfssystem und gut 
ist.

Ob es schön ist, interessiert in der heutigen Zeit kein Mensch. 
Wichtiger ist, das es kompakt ist, und Dinge schnell zu finden ist. Sehr 
viele Handbücher MÜSSEN heutzutage auf Handys + Tabletts lesbar sein.

Ich habe in meinen Leben mehr als ein Techniker fluchen hören, weil das 
Handbuch nicht gut lesbar war auf seinen Gerät. Grund : Gescannte PDF's.

von Schlaumaier (Gast)


Lesenswert?

Nachtrag :

Bei sehr vielen Geräten wo ich noch eine CD dabei habe, ist das 
Hilfssysteme im HTML erstellt worden.

Du kannst also dein Handbuch auch in HTML erstellen. Das hätte 
gigantische Vorteile.

1.) Man kann prima suchen. (notfalls ein bisschen Datenbank 
hinterlegen).

2.) Man kann es Online-Stellen und dort schnell updaten.

3.) Man kann es 1:1 als Zip-Paket ausliefern zum Update.

und was für dich wichtig ist. Man brauch keine Vorgeschriebene Ordnung. 
Kein Inhaltsverzeichnis mit Seiten-Nr. und kann jedezeit ein Kapitel 
irgendwo dazwischen setzen.

Denk mal als Alternative drüber nach.

Ich hatte damals auf der Firma eine Software mit der ich CHM (Altes 
Windows-Hilfs-System) Dateien erstellen konnte für meine Software.
Leider weiß ich den Namen nicht mehr. Aber CHM ist eh veraltert.

P.s. : Ich wette das es da Software gibt, mit der man so was schnell 
machen kann.

von Andreas B. (bitverdreher)


Lesenswert?

Schlaumaier schrieb:
> Handbücher sind so was von OUT.
>
> Heutzutage nutzt man Hilfs-Systeme.

Jetzt wissen wir endlich warum Du so wenig Ahnung hast.

von Pc-Freak (Gast)


Lesenswert?

Schlaumaier schrieb:
> Handbücher sind so was von OUT.

Bei Dir gibts auch kein PDF?
Nur Steinplatten, wie bei den Feuersteins?!

von Schlaumaier (Gast)


Lesenswert?

Andreas B. schrieb:
> Jetzt wissen wir endlich warum Du so wenig Ahnung hast.

Nutzt du ein OS. Windows oder Linux. ??

Zeig mir mal ein Foto deines HANDBUCH, was der Hersteller ausgeliefert 
hat.

Hat du ein TV. Zeig mir das Handbuch wo jede Einstellung beschrieben 
ist. Und ich meine keine Fotos des Hilfssystem im TV selbst. ;)

JEDE brauchbare Software hat ein Hilfs-System.

Das kann ich unbegrenzt so weiter machen.

Das einzige was man noch als "Buch" bekommt sind PDF's von Elekrogeräten 
wo dann 20 Seiten drinsteht das es eine schlechte Idee ist, die in der 
Spülmaschine zu reinigen. Und das man sich nicht erwischen lassen soll 
wenn man sie in die falsche Tonne schmeisst.

Richtige Handbücher sind auf Grund der Komplexität der Sache viel zu 
überwältigend.

Und die Studie wonach kaum jemand die liest, ist schon 20 Jahre alt.

von Schlaumaier (Gast)


Lesenswert?

20 Sek. Google.

https://miraminds.com/de/flowshare-dokumentationssoftware

Da musst du angeblich nicht einmal großartig was machen. ;)

Aber Preiswert ist das nicht.

von Schlaumaier (Gast)


Lesenswert?

Nachtrag.

https://www.lexican.de/de/handbuch-erstellen

Und so was z.b. für ein HTML-Handbuch ;)

von Peter (Gast)


Lesenswert?

Für Handbücher kann ich Scribus empfehlen.
Läuft auf fast jedem Betriebssystem und man kann damit recht gut 
Handbücher machen. Die sehen dann auch immer genau so aus wie man es 
gemacht hat.
Ich habe allerdings bis jetzt nur PDF Export gemacht, sollten ja weiter 
gegeben oder Ausgedruckt  werden.

Latex geht auch überall, im notfall würde auch ein  Office Paket gehen. 
Ich persönlich würde damit allerdings kein Handbuch erstellen, auch wenn 
es geht.
Im Grunde kann man auch mit dem VI ein Handbuch schreiben, ist dann nur 
nicht so schön.


Aber dran denken Scribus ist kein WORD oder sonstiger Office Paket 
Ersatz!
Und somit fehlen viele der Funktionen.
Also Texte vorschreiben und dann setzen.

von J.V. (Gast)


Lesenswert?

Ein gutes Beispiel, wie man es machen kann liefert das Buch Managing 
Projects with GNU Make, 3rd Edition by Robert Mecklenburg. In Kapitel 11 
erklärt der Verfasser den Makefile, der das Buch zusammen stellt. Dabei 
werden die Beispiele alle getestet, bevor sie im Buch kommen.

von Hans (Gast)


Angehängte Dateien:

Lesenswert?

LaTeX ist für einen Mathematiker, der öfters Abhandlungen schreibt 
sicher optimal. Aber die kurzfristige Einarbeitung funktioniert bei 
normalen Menschen nicht. Da scheitert es dann schon gleich bei der 
Erstellung etwas komplizierteren Tabellen (siehe Beispiel) oder bei sehr 
großen Tabellen im Querdruck auf einer einzelnen A4-Seite. Gleiches bei 
kleineren Bildern oder Tabellen, die von Text umflossen werden sollen.

von Udo S. (urschmitt)


Lesenswert?

MaWin schrieb:
> für Idioten

Du meinst solche Idioten die Nicknames von anderen klauen?

: Bearbeitet durch User
von Udo S. (urschmitt)


Lesenswert?

Der Troll namens "Handbuch" trollt inzwischen woanders.

von Toxic (Gast)


Lesenswert?

Fuer meine eigene Projekte oder sonstige private Dokumente verwende ich 
eigentlich nur einen PDF-Editor.
Jahrelang habe ich mit Freeware rumgeeiert bis ich endlich mal einen 
vollwertigen Editor gekauft habe.
Meine Wahl viel nach eigenen Tests auf den PDF-Xchange Editor:
https://www.tracker-software.com/product/pdf-xchange-editor
Wer die 40€ dafuer nicht ausgeben kann tut mir schon leid.

Ich habe mir die Proversion geleistet - die paar Euro mehr machen den 
Kohl nicht fett,zumal dieses Programm bei mir staendig benutzt wird.
Dazu kann man sich noch das freie Flowchart-Programm von yEd
https://www.yworks.com/products/yed/download
herunterladen.Die damit erstellten Flowcharts lassen sich problemlos in 
pdf umwandeln und mit in's "Handbuch" integrieren.
Jeder der heute irgendwas kauft,bekommt die dazugehoerenden Handbuecher 
sowieso als pdf-Datei.....
====================
Was spricht fuer Xchange-Editor?
1.Hervorragende Software
2.Hervorragender Service - extra Forum wo man in der Regel binnen 
weniger einer Stunde eine professionelle Antwort auf Fragen bekommt.
3.Editor gibt's auch als Freeware-also reiner pdf-Viewer
4.portable Version erhaeltlich und Software darf auf 2 Rechnern 
installiert werden.
5.Auch Freeware-User duerfen im Forum mitmischen und haben gleiche 
"Rechte" wie alle anderen.Die Firma will sogar,dass auch Free-User 
teilnehmen um eventuelle festgestellt Softwareprobleme bei einem 
naechsten Update beseitigen zu koennen
6.Adobe kann sich eine Scheibe davon abschneiden-deren freien pdf reader 
kann man sich sonstwohin stecken....

von Zeno (Gast)


Lesenswert?

Hans schrieb:
> LaTeX ist für einen Mathematiker, der öfters Abhandlungen schreibt
> sicher optimal. Aber die kurzfristige Einarbeitung funktioniert bei
> normalen Menschen nicht. Da scheitert es dann schon gleich bei der
> Erstellung etwas komplizierteren Tabellen (siehe Beispiel) oder bei sehr
> großen Tabellen im Querdruck auf einer einzelnen A4-Seite. Gleiches bei
> kleineren Bildern oder Tabellen, die von Text umflossen werden sollen.

Nö, wenn man es einmal begriffen hat sind auch solche Tabellen keine 
Hürde. Man kann die sich sogar als Macro ablegen und kann die dann immer 
wieder verwenden. Oder man macht für die Tabelle 1x eine passende Datei 
die man dann beliebig oft in beliebig vielen Dokumenten bzw. 
Dokumentprojekten mit einem einfachen Befehl dort einsetzen kann, wo man 
es gern hätte.

TeX hat eigentlich nur 1 Problem, man muß es wollen. Wenn man dann 
bereit ist sich mal hinzusetzen und die Basics zu lernen und sich dabei 
von den üblichen Officesuiten löst, bekommt man recht schnell ein gut 
aussehendes Dokument hin. Man lern recht schnell sich da Textbausteine 
und Makros zu bauen die man dann immer wieder einsetzen kann.
Ich habe auch eine Weile gebraucht bis ich mich mit TeX anfreunden 
konnte. Mit TeXnicCenter z.B. kann man fast so schreiben wie man es von 
Word gewohnt ist, mit dem Vorteil das man sich um solche Dinge wie 
Nummerierungen, linke/rechte Seiten und Stile nicht weiter kümmern muß. 
Und wenn es wirklich mal tricky wird findet man im Netz auch recht 
schnell eine passende Hilfestellung.

Heißt jetzt nicht das ich alles mit TeX mache, aber technische 
Beschreibungen, Bedienungsanleitungen etc. mittlerweile schon fast 
ausschließlich.

von Voodoopriester (Gast)


Lesenswert?

lexi schrieb:
> ch komme mit LaTeX einfach nicht klar... Ich kann AsciiDoc empfehlen
> (https://asciidoc.org/). Ist zwar nicht so mächtig wie LaTeX, aber für
> vieles absolut ausreichend.

Cool, quasi ein abgespecktes docbook in bedienbar, ohne xml-bloat vor 
der Nase. Selbst der "Quelltext" ist direkt lesbar und sieht zu90% aus 
wie ein normaler ascii-text ohne störend auffallende 
Formatierungszeichen.

von W.S. (Gast)


Lesenswert?

Diese Diskussion geht mE am eigentlichen Thema vorbei.
Ich sag's nochmal: Es ist eigentlich so ziemlich egal, was für ein 
Programm man dazu benutzt, die Dokumentation hinzuschreiben. Notfalls 
auch Paint...

Das wirklich Wichtige ist, daß es eine Dokumentation ist und nicht 
bloß ein Haufen hingeworfener Wörter, Diagramme oder Tabellen.

W.S.

von Kolja L. (kolja82)


Lesenswert?

oerks schrieb:
> Aber wenn man es vermeiden kann, sollte man Word wirklich nicht fuer 
Dokumentationen verwenden.

HohnUndSpott
Ich erhöhe auf: Dokumente.
Aber heißt ja schließlich auch Word und es hält was es verspricht. Ein 
Wort, eine Schriftart - kein Problem. Okay, außer man möchte das Wort 
ausdrucken.

Hab MA und paper in LaTeX geschrieben, ist schön, macht Spaß. Die 
Lernkurve ist allerdings sehr steil, wenn man keine gute Vorlage hat, 
oder nicht triviale Anforderungen.
Für die paper konnte ich in der gegebenen Vorlage einfach lorem ipsum 
gegen meinen Inhalt tauschen und nach dem kompilieren war das paper 
fertig. Naja, also zumindest optisch.

von René H. (mumpel)


Lesenswert?

Markus schrieb:
> Es ist sogar möglich, einzelne Kapitel in unterschiedlichen Dateien zu
> speichern, falls es zu umfangreich werden würde.

Du meinst Zentral- und Filialdokument. Da muss man sich aber auch erst 
einarbeiten.

von Mehmet K. (mkmk)


Lesenswert?

lexi schrieb:
> Ich komme mit LaTeX einfach nicht klar... Ich kann AsciiDoc empfehlen

Auch ich hatte so meine Mühe mit LaTeX, weshalb ich wieder bei 
LibreOffice gelandet war.
Danke für den Tipp mit AsciiDoc. Scheint sehr vielversprechend zu sein. 
Und zusammen mit AsciidocFX hat man als Anfänger auch gleich sein 
Aha-Erlebnis.

von Zeno (Gast)


Lesenswert?

Markus schrieb:
> Es ist sogar möglich, einzelne Kapitel in
> unterschiedlichen Dateien zu speichern, ....
Du meinst ein Masterdokument, welches aus Einzeldokumenten 
zusammengesetzt wird?
Wirklich 'ne tolle Errungenschaft. Wenn dieses Feature schon vor knapp 
18 Jahren funktioniert hätte, wäre mir viel Arbeit erspart geblieben und 
einige Klimmzüge beim Ausfüllen vorgegebener Templates per OLE wären 
nicht nötig gewesen. Aber "Hätte hätte Fahrradkette", Word war damals 
einfach zu blöd dazu. AmiPro bzw. der Nachfolger WordPro konnten das 
damals schon lange. Schade das die Lotussuite eingeschlafen ist, ich 
habe mit den Programmen gern gearbeitet und die waren seinerzeit 
MSOffice in einigen Punkten auch voraus. Naja ist halt vorbei.

von Voodoopriester (Gast)


Lesenswert?

Zeno schrieb:
> AmiPro bzw. der Nachfolger WordPro konnten das
> damals schon lange. Schade das die Lotussuite eingeschlafen ist, ich
> habe mit den Programmen gern gearbeitet und die waren seinerzeit
> MSOffice in einigen Punkten auch voraus. Naja ist halt vorbei.

Stabil war das aber auch nicht. Formeleditor brachte das Teil in 
schnellster Zeit zum Abturz samt demoliertem Dokument. Das Ding war 
Kernschrott^2.
Dann kamen immer bugfixes aber die üblen Bugs waren immer noch drinn.

von Zeno (Gast)


Lesenswert?

Voodoopriester schrieb:
> Stabil war das aber auch nicht. Formeleditor brachte das Teil in
> schnellster Zeit zum Abturz samt demoliertem Dokument. Das Ding war
> Kernschrott^2.
> Dann kamen immer bugfixes aber die üblen Bugs waren immer noch drinn.
Nö kann ich nicht behaupten. Hat bei mir immer ordentlich funktioniert - 
zumindest bei WordPro. Zu AmiPro kann ich da nix sagen.
Die Smartsuiteprogramme sind nicht häufiger abgestürzt als andere 
Programme auch. Das lag aber wohl weniger an den Programmen selbst, 
sondern mehr am BS - damals Win98. Mit Win2k war der Spuk dann im großen 
und ganzen vorbei und es lief alles recht stabil.

von A. S. (achs)


Lesenswert?

Ich kenne DTPs nicht, hatte aber gedacht, dass die eher zum "manuellen" 
setzen sind. Also um eine Zeitschrift oder ein Buch zu setzen, was dann 
so 10 oder 10.000 Mal verkauft wird.

Bei einem Handbuch heutzutage, dass quasi täglich aktualisiert wird, 
will ich ja eher was wie Latex oder HTML, wo es keine Rolle spielt, ob 
die Überschrift auf einmal 100 Zeichen hat, der Text ne halbe Seite mehr 
oder 3 Grafiken auf die nächste Seite rutschen.

Kann ein DTP das?

Kann Latex das?

Wir hatten sowas wie ASCII-Doc, aber am Ende waren Tabellen doch eng 
spezifiziert und ungebrochen, weil es automatisch schei**e aussah.

von Zeno (Gast)


Lesenswert?

A. S. schrieb:
> Kann Latex das?
Ja!

von Karl (Gast)


Lesenswert?

Mehmet K. schrieb:
> Auch ich hatte so meine Mühe mit LaTeX, weshalb ich wieder bei
> LibreOffice gelandet war.

Schaut euch einfach Mal Lyx an.

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.