Get best of the week

So machen Sie Ihren Artikel oder Ihre Dokumentation schnell und genau verstÀndlich

Nicht nur der Inhalt, sondern auch die Struktur des Textes sollte aussagekrÀftig sein.

Wenn es sich also um einen technischen oder wissenschaftlichen Text handelt, beispielsweise um einen Artikel oder eine Dokumentation, sollte das Formular dazu beitragen, den Inhalt schnell und einfach zu verstehen. FĂŒr mich bedeutet dies im Fall des Artikels, dass die Struktur ungefĂ€hr so ​​aussehen sollte:

  • Überschrift
  • Das Wesentliche des Artikels
    Basierend auf diesen wenigen SĂ€tzen und der Überschrift muss der Leser verstehen, ob er daran interessiert ist, diesen Artikel weiter zu lesen.
  • Zusammenfassung
    Hier sollte in der prĂ€gnantesten Form, These, aber mit der erforderlichen Genauigkeit und VollstĂ€ndigkeit, das Wesentliche dieses Artikels reflektiert werden - von mehreren SĂ€tzen bis zu mehreren Seiten. Jemand, der tief in das Thema vertieft ist, kann ausreichen, um den gesamten Artikel zu verstehen. In jedem Fall ist es fĂŒr den Leser nĂŒtzlich, in der allgemeinsten Form darzustellen, worum es in diesem Artikel geht und welche Schlussfolgerungen er am Ende erhalten wird.
  • Die Logik des Artikels
    Wenn der Artikel lang ist, viele Abschnitte und komplexe Logik enthĂ€lt, kann dieses Kapitel auch nĂŒtzlich sein. Dies ist im Wesentlichen ein erweitertes Inhaltsverzeichnis. Hier wird kurz auf ein oder zwei Seiten die Logik des Denkens trocken und ohne Einzelheiten dargelegt. Auch dies wird ausreichen, damit jemand alles versteht. Wenn es schwierig ist, kann der Leser dies (als Inhaltsverzeichnis) ĂŒberspringen und weiterlesen.
  • Vereinfachte Darstellung
    Wenn der Artikel recht kompliziert ist, ist es fĂŒr viele praktisch, zunĂ€chst konzeptionell zu verstehen, was der Autor sagen möchte. Daher ist es gut, zuerst alles so zu sagen, als ob Sie es den SchĂŒlern erzĂ€hlen wĂŒrden, komplexe Beweise fehlen und vielleicht nicht in einer so formalen und strengen Sprache. FĂŒr so viele mag diese PrĂ€sentationsstufe ausreichend sein, und sie werden hier aufhören.
  • Strikte PrĂ€sentation
    Hier ist eine streng professionelle PrÀsentation.

NatĂŒrlich muss die Struktur nicht genau das sein. AbhĂ€ngig von der KomplexitĂ€t und LĂ€nge des Textes können beispielsweise einige Abschnitte redundant sein oder umgekehrt hinzugefĂŒgt werden, aber die Struktur sollte fĂŒr den Zweck geeignet sein. In diesem Fall ermöglicht der angegebene Ansatz dem Leser, den Inhalt eines komplexen Artikels so schnell wie möglich und mit dem erforderlichen Grad an Tiefe zu verstehen. Ich habe diesen Ansatz verwendet, als ich den Artikel Nichtlineare Differentialgleichungen, die Diskretion von Raum-Zeit und Epsilon-Produkt geschrieben habe . Sie sehen alle Elemente außer dem letzten.

Ich muss viel technische Dokumentation lesen. Meiner Meinung nach ist die allgemein akzeptierte Organisation des Textes unpraktisch. Ich habe keine Zeit (und keinen Wunsch), die konsequente Entwicklung der Handlung und die Schönheit der Silbe zu genießen. Dies ist nicht „Krieg und Frieden“. Ich brauche nur Informationen und je schneller, desto besser. Daher muss ich bei einem neuen und komplexen Thema den Text zuerst mehrmals scannen, um nach Bedeutungen, Schlussfolgerungen und Logik zu suchen, und erst dann kann ich ihn angemessen wahrnehmen. Das heißt, ich folge dem beschriebenen Ansatz, aber auf sehr unbequeme und zeitaufwĂ€ndige Weise, und es wĂ€re fĂŒr mich viel bequemer, wenn die Informationen sofort entsprechend organisiert wĂŒrden.

More articles:


All Articles