Was kann ich tun, damit meine Probleme schnell eine Lösung finden?

In den Foren werden immer wieder Beiträge verfasst, die von den Administratoren, den Moderatoren und vielen Anwendern als unzureichend betrachtet werden. Solche Beiträge sind häufig schwer zu beantworten. Dadurch kosten sie potentielle Helfer nicht nur unnötig viel Zeit, sie führen auch bei allen Beteiligten – Helfern und Fragestellern! – häufig zu Frustration und Demotivation. Nicht selten entzünden sich daran unsägliche Diskussionen und Beschimpfungen von Teilnehmen. Insbesondere für Anfänger ist es nützlich zu erfahren, welche Unzulänglichkeiten sie vermeiden sollten.

Unzureichende Beiträge oder Themen im Forum sind Beiträge die min. eines der folgenden Kennzeichen tragen:

• Ein Problem ist in so konfuser Weise beschrieben, dass es voraussichtlich nur von jemandem verstanden und gelöst werden kann, der dem Verfasser des Beitrags bei seiner Arbeit über die Schulter geschaut hat. Häufige Versäumnisse dabei sind:
  • Es wird nicht angegeben, was genau nicht funktioniert.
  • Statt Fehlermeldungen zu zitieren, wird nur geschrieben, dass es einen Fehler gibt.
  • Es wird vorausgesetzt, dass alle Menschen mit denselben Klassen und Paketen in demselben Fachbereich arbeiten.
  • Begriffe, die in der Typografie oder bei LaTeX klar definiert sind, werden total falsch verwendet (beispielsweise werden Verzeichnisnamen durcheinander geworfen).
  • Statt etablierte Begriffe aus dem Bereich Typografie und LaTeX zu verwenden, die man in den verfügbaren Anleitungen nachschlagen kann, werden eigene Begriffe und Abkürzungen verwendet, ohne dass diese erklärt werden.
  • Es werden Begriffe oder Abkürzungen aus eigenen Fachbereichen verwendet, die kein Allgemeingut sind, ohne dass die Abkürzungen oder Begriffe erläutert werden.
• Eine Problembeschreibung enthält kein vollständiges Minimalbeispiel, mit dessen Hilfe jederman das Problem reproduzieren kann.
• Ein angegebenes Beispiel ist kein vollständiges Minimalbeispiel, sondern nur ein Code-Ausschnitt. Häufigste Fehler in diesem Zusammenhang sind:
  • Es wird nur eine Dokumentpräambel angegeben.
  • Die Dokumentpräambel wird weggelassen.
  • Die Dokumentpräambel wird nicht minimiert, also nicht durch Versuch und Irrtum von für das Problem unerheblichen Paketen und Definitionen befreit.
  • Es werden nicht frei verfügbare Pakete verwendet.
  • Es werden frei verfügbare Pakete verwendet, die nicht auf CTAN zur Verfügung stehen, und keine alternative Quelle für diese Pakete angegeben.
  • Es wird nur ein Hauptdokument angegeben, in dem weitere Dateien geladen werden. Diese weiteren Dateien fehlen jedoch.
  • Es werden weitere Dateien wie Abbildungen, PDF-Dateien, Literaturverzeichnisse oder andere benötigt, diese werden jedoch nicht zur Verfügung gestellt.
  • Bei der Einbindung des Pakets graphics oder graphicx wird nicht die Paketoption demo verwendet und die \includegraphics-Anweisungen wurden auch nicht durch \rule-Anweisungen gleicher Größe und die Abbildungen selbst auch nicht durch die frei verfügbaren Abbildungen des Pakets mwe ersetzt.
• Ein angegebenes Beispiel ist kein vollständiges Minimalbeispiel, weil es nicht annähernd minimal ist. Häufigste Fehler in diesem Zusammenhang sind:
  • Obwohl per \input oder \include geladene Dateien ebenso gut in die Hauptdatei des Minimalbeispiels eingefügt werden könnten, werden diese getrennt angegeben und so die Verarbeitung erschwert.
  • Obwohl zusätzliche Dateien per filecontents-Umgebung in der Hauptdatei des Beispiels zur Verfügung gestellt werden könnten, wird dies unterlassen und so die Verarbeitung erschwert. (Hinweis: Es wird ggf. die Verwendung des Pakets filecontents empfohlen.)
  • Statt sich eines der Pakete blindtext oder lipsum bzw. mwe zu bedienen, wird ein Minimalbeispiel mit massenhaft Text versehen.
  • Die Präambel wird einfach unverändert vom Originaldokument übernommen, statt sie durch Versuch und Irrtum auf die Teile zu reduzieren, die für das Problem von Bedeutung sind. Pakete, die von dieser Regel ausgenommen sind, sind lediglich:
    

    \usepackage[utf8]{inputenc}% Das ist die Codierung des KOMA-Script Documentation Projects! Alternative wäre selinput mit entsprechender \SelectInputMappings-Anweisung.
    \usepackage[ngerman]{babel}% ggf. sind hier andere oder zusätzliche Sprachen zulässig
    \usepackage[T1]{fontenc}% ggf. sind hier andere oder zusätzliche Codierungen sinnvoll
    \usepackage{fontspec}% hieran erkennt man dann auch gleich, dass xelatex oder lualatex verwendet wird (natürlich nicht mit inputenc und fontenc zu kombinieren)
    \usepackage{lmodern}% nur, wenn nicht andere Font-Pakete für das Problem maßgeblich sind
    \usepackage{lipsum}% alternativ kann das Paket blindtext oder mwe verwendet werden
    \usepackage{filecontents}% nur, falls externe Dateien unumgänglich sind, die über eine filecontents-Umgebung einfach bereit gestellt werden können

  • In der Präambel werden unzählige Einstellungen und Definitionen vorgenommen, die für das Problem gänzlich unerheblich sind, und so die Übersicht und die Suche nach dem Problem nur erschweren. Diese sind ggf. durch Versuch und Irrtum zu entfernen.
• Der Code des Beispiels wurde als normaler Text angegeben, statt ihn als Code auszuzeichnen.
• Es ist zwar ein ordentliches vollständiges Minimalbeispiel und auch einer Beschreibung dessen, was der Anwender getan hat, vorhanden, aber eine konkrete Frage ist nicht zu erkennen.
• Es wurde nicht kontrolliert, ob die aktuelle KOMA-Script-Release verwendet wird, und gleichzeitig wurde nicht angegeben, welche KOMA-Script-Version und ggf. welche Version von am Problem beteiligten anderen Paketen verwendet wurde. Hinweis: Diese Information findet sich in der Regel in der log-Datei des LaTeX-Laufs des vollständigen Minimalbeispiels. Am übersichtlichsten erhält man diese Informationen, wenn man die Anweisung \listfiles als erste Zeile im vollständigen Minimalbeispiel einfügt.
• Das Problem ist von einer bestimmten Verarbeitung, beispielsweise der Verwendung von pdflatex, abhängig, diese Information fehlt aber in der Problembeschreibung.
• Es wurde nicht getestet, ob das Problem auch mit den Standardklassen auftritt und daher vermutlich kein KOMA-Script-Problem ist und deshalb allenfalls in das Forum Off_Topic gehört.
• Es werden störende Optionen verwendet, die eine bestimmte Verarbeitung voraussetzen, aber diese Verarbeitung ist für das Problem nicht zwingend oder in der Problembeschreibung nicht angegeben. Beispiele für solche Optionen können pdftex, dvips, dvipdfm aber auch andere sein.
• Es werden Anweisungen oder Pakete verwendet, die allgemein, beispielsweise in »Das LaTeX2e-Sündenregister«, als obsolet dokumentiert sind.

Obwohl obige Aufzählung sehr umfangreich erscheint, ist leider nicht davon auszugehen, dass sie erschöpfend ist. Alle Teilnehmer, sowohl neue als auch langjährige, sollten jedoch bemüht sein, zumindest diese Hinweise zu beachten.