Einführung: Wie man beitragen kann

Qualitativ hochwertige Dokumentation zu erstellen ist sowohl eine Frage des Inhalts wie auch der Struktur. Der Inhalt selbst muss dabei so pädagogisch wie möglich sein für die Zielgruppe der Leser. Um dies zu erreichen, sollte man nicht zögern, so viele Beispiele und Illustrationen (z.B. Screenshots) einzufügen, wie es sinnvoll ist. Gleichwohl die Dokumentation nicht notwendigerweise den Anspruch hat, komplett zu sein, peilen wir doch eine relativ stabile Dokumenation an. Inbesondere sollte man den Text nach Rechtschreibfehlern durchsuchen lassen. Die mehr unausgereifte Dokumentation sollte das incoming Verzeichnis gestellt werden oder auf TeXmacs Wiki.

Es ist ebenso wichtig, daß sie der Dokumenation so viel Struktur geben wie möglich, und zwar durch Anwendung der speziellen Markups der tmdoc Stil-Datei. Die dort definierte Struktur kann genutzt werden um automatisch druckfertige Bücher zu kompilieren, um Dokumentation schnell brauchbar für andere Sichtformate zu machen, oder um die Dokumenation effektiv nach bestimmten Information zu durchsuchen. Insbesondere sollten sie stets die Urheberrechts- und Lizenzinformationen enthalten, ebenso wie Hinweise wie man die Dokumentation durchlaufen kann, wenn sie viele Dateien enthält.