Suche

Überschriften als separate Module

Frage

Gibt es eine grundsätzliche Empfehlung, wie mit Überschriften umgegangen werden soll? Besser im Modul zusammen mit dem Text oder separat als einzelne Module?

Dann gibt es ja auch noch die Funktion "Dokumentstruktur", in der man die Überschriftenebenen festlegen kann. Ist es also sinnvoll, sämtliche Überschriften in den Modulen mit der selben Ebene anzulegen (z. B. nur Überschrift 1)?

Hinweis

Die Vorgehensweise ist natürlich abhängig von den zu dokumentierenden Produkten, Dokumentenarten sowie kundenseitigen oder persönlichen Befindlichkeiten.

Grundsätzlich empfehlen wir zum Umgang mit Überschriften und der Funktion Dokumentstruktur folgendes Verfahren:

  • Überschriften erster Ebene in einem eigenen Modulordner mit der Formatvorlage Überschrift 1 als separates Modul anlegen.
  • Überschriften zweiter Ebene in einem eigenen Modulordner mit der Formatvorlage Überschrift 2 als separates Modul anlegen.
  • Indexmarken innerhalb dieser Module an separaten Absatz mit eigener Formatvorlage (z. B. dl_Indexeintrag), sichtbar im Modul (in der Modulvorlage entsprechend definieren), unsichtbar im Dokument (in der Dokumentvorlage entsprechend definieren). Siehe hierzu auch folgen Tipps&Tricks-Beitrag.
  • Ab Überschriftebene drei, werden die Überschriften in Modulen zusammen mit dem Text platziert, da davon auszugehen ist, dass ab dieser Ebene die Informationen so spezifisch sind, dass eine Wiederverwendung eher selten sein wird und somit die Separierung dem Nutzen aufwandseitig nicht gerecht wird. Indexmarken wie oben beschrieben.
  • Die Funktion Dokustruktur dient im Wesentlichen der Kontrolle einer korrekten Überschriftenebenen-Struktur und erlaubt diese, falls notwendig, anzupassen.