Schöne Texte mit Markdown schreiben
Beim professionellen Schreiben von Texten gilt es mehrere Perspektiven zu berücksichtigen. Neben den rein technischen Fragen rund um den Textsatz muss ein guter Text auch übersichtlich und verständlich aufbereitet sein. Im Kontext der Prüfungsvorbereitung betrifft das vor allem die Didaktik Ihrer Erklärungen.
Technisches: Markdown-Syntax
Als ersten Anlaufpunkt nutzen wir markdownguide.org. Bevor Sie Ihre Texte committen und pushen, überprüfen Sie bitte, wie Ihr Markdown-Code voraussichtlich von docusaurus gerendert wird, z. B. mit dem Preview-Tab im Github-Editor oder extern via md2pdf.netlify.app.
Wie man verständlich schreibt
Der Übersichtlichkeit halber verwenden wir im Folgenden nicht nur Fließtext, sondern auch stichwortartige Listen Absätze und Textformatierungen.
Schreiben als soziale Tätigkeit
Die Texte, die Sie hier schreiben, dienen der Kommunikation. Sie sollen Ideen und Zusammenhänge aus den Lernfeldern Ihrer Ausbildung verständlich darstellen. Genauso wie Sie im direkten Gespräch oder in einer Fachdiskussion etwas erklären und dafür zunächst den Kontext herstellen müssen, gehen Sie auch in der schriftlichen Kommunikation vor. Dabei gibt es allerdings einen essenziellen Unterschied:
Die Lesenden können Ihren Texten keine Rückfragen stellen, wenn etwas unklar ist.
Sie müssen also beim Schreiben antizipieren, welche Rückfragen kommen könnten und die Fragen bereits im Vorfeld beantworten. Übersichtliche Strukturierung des Textes mit Zwischenüberschriften, Absätzen, Formatierung wie etwa Fettschreibung oder Codeblöcke helfen, die Informationen besser aufzunehmen. Unterschätzen Sie nicht den Wert der visuellen Darstellung Ihrer Texte. Dies gilt auch für Prüfungssituationen. Je leichter Ihre Lösungen zu verstehen sind, selbst wenn Sie kleine Denkfehler enthalten, desto mehr Punkte können Sie von den Prüfenden erhalten.