MS Word ist böse! Gibt es eine gute Alternative?

Question

Als Entwickler schreibe ich wirklich nicht gerne Dokumentationen, aber wenn ich sie schreiben muss, möchte ich den Prozess so schmerzlos wie möglich gestalten.

Das Problem mit Word ist, dass es kommt mir ständig in die Quere . Ich mache mir mehr Gedanken über das Layout als über den eigentlichen Inhalt ... deshalb würde ich Word gerne loswerden.

Idealerweise würde ich meine Inhalte schreiben und sie dann in einem Dokument "zusammenstellen".

Ich habe gehört, dass LaTeX aber ich habe keinerlei Erfahrung mit dieser Technologie. Wäre dies die richtige Technologie für diese Aufgabe? Welchen Editor (Windows) sollte ich verwenden? Ist es eine gute Idee, mit LyX ?

EDIT: Ich frage nicht nach der Dokumentation von Code (ich verwende Sandcastle dafür).

---

Update 2014:

Wir haben jetzt umgestellt auf GFM (GitHub Flavored Markdown) .

• Es ist wirklich einfach, damit zu arbeiten.
• Schreiben Sie Code und Dokumentation in der gleichen IDE!
• Alles kann versioniert werden!
• Sie erhalten eine großartige Ausgabe entweder als rohe txt, html o pdf !

Answer 1

Meine Lösung bestand darin, einige Zeit in die Erstellung einer anständigen Word-Vorlage für mich selbst zu investieren.

Wichtig ist, dass Sie für alles, was Sie in das Dokument einfügen können, einen Stil festlegen.

Sobald Sie alle Stile definiert haben und der gesamte Inhalt des Dokuments ist mit dem richtigen Stil gekennzeichnet statt ad hoc formatiert, werden Sie überrascht sein, wie einfach es ist, jedes Mal schnell gut aussehende Word-Dokumente zu erstellen.

Das größere Problem dabei ist, dass jeder stundenlang mit Word arbeitet, die Unternehmen aber nur selten in Word-Schulungen investieren. Irgendwann muss man in den sauren Apfel beißen und sich die Zeit nehmen, sich den richtigen Umgang mit dem Programm beizubringen, so wie bei jedem anderen Programm auch.

Answer 2

Alles, was Sie mit LyX machen können, können Sie auch mit LaTeX machen. LaTeX eignet sich für alle möglichen Dinge; es wurde für alles verwendet, von Handbüchern über Vorlesungsfolien bis hin zu Romanen.

Ich denke, LaTeX ist wahrscheinlich eine Überlegung wert; wenn Sie schon immer einmal für Ihr Textverarbeitungsprogramm "programmieren" wollten, ist LaTeX genau das Richtige für Sie. Auf der einfachsten Ebene können Sie neue Befehle definieren, um Dinge für Sie zu erledigen, aber es gibt eine Menge Möglichkeiten. Und die Ausgabe sieht so aus realmente ordentlich.

Meiner Meinung nach ist LyX in bestimmten Situationen fantastisch, in anderen praktisch, und manchmal ist es einfach nur hinderlich. Ich denke, es sollte als Produktivitätsverstärker für LaTeX betrachtet werden. Mit anderen Worten, den Umgang mit LaTeX lernen, bevor Sie LyX ausprobieren . Beide sind natürlich kostenlos und für Windows verfügbar, allerdings ist die Lernkurve im Vergleich zu MS Word recht steil. Für lange Dokumente oder viele ähnliche Dokumente ist LaTeX/LyX wahrscheinlich eine lohnende Investition.

Answer 3

Ich habe festgestellt, dass Wikis dafür gut geeignet sind. Finden Sie ein Wiki, das Ihnen gefällt und in dem Sie eine bit der Formatierung, aber nichts wirklich Schweres. Idealerweise sollten Sie damit auch Code leicht formatieren können - um ehrlich zu sein, ist das in SO verfügbare Markdown wahrscheinlich ein guter Anfang.

Auf diese Weise:

• Sie haben eine integrierte Änderungsverfolgung (ein gutes Wiki vorausgesetzt)
• Sie können von überall aus bearbeiten
• Jeder sieht immer die gleichen Unterlagen (sofortige Verteilung)
• Sie können sich auf den Inhalt statt auf die Formatierung konzentrieren

Answer 4

Sie können Ihre Dokumentation in Ihrem eigenen XML-Format verfassen und sie dann mit XSL in ein beliebiges Format umwandeln (z. B. PDF über FOP+XSL-FO ). Siehe auch die DocBook XML-Format.

Answer 5

LaTeX ist ein extrem ein leistungsfähiges Werkzeug, das hier vielleicht zu viel des Guten ist, da es für wissenschaftliche/mathematische Literatur konzipiert ist. Es hat eine (relativ) steile Lernkurve und es kann schwierig sein, es dazu zu bringen, genau das zu tun, was man will, wenn man neu darin ist. Ich LIEBE LaTeX, aber es ist nicht wirklich ein Allzweck-Textverarbeitungsprogramm.

Haben Sie stattdessen OpenOffice in Betracht gezogen?