Verständlich Schreiben

Ankündigungstext

Wir alle freuen uns über gute Doku, wenn wir etwas Neues lernen. Doch wie sieht es mit der Doku für unsere eigenen Projekte aus? Ist sie a) vorhanden und b) verständlich geschrieben?

Gut zu schreiben kann man lernen. Im Workshop verbessern wir "fertige" Texte in mehreren Schritten. Bring also gerne Deine vorhandenen Texte mit, um sie zu verfeinern! Es muss auch nicht unbedingt eine Dokumentation sein, da die meisten Regeln für alle Arten von Text gelten. Für alle die noch keine Texte haben bringt Corinna Übungstexte mit.

Das Überarbeiten geht am besten mit einem Laptop. Alternativ kannst Du auf totem Baum mitmachen.

Der Workshop orientiert sich an diesem Artikel von Su-Shee

Übungen

Feinschliff

Kopien austeilen?

Textauszug kopiert und adaptiert (d.h. verschlimmert) von Wikipedia/Compiler

Ausgangstext

Der erste Compiler (A-0) wurde 1952 von der Mathematikerin Grace Hopper kreirt. Programmierer reihten ausschließlich Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand und damit Symbolik der Mathematik sowie natürliche Sprache für die Programmierung erschloss. Am 3. Mai 1952 stellte Hopper erstmals öffentlich den ersten Compiler A-0 vor, der Algorithmen aus einem Katalog abrief, Code umschrieb, in passender Sequenz zusammenstellte, Speicherplatz reservierte und die Zuteilung von Speicheradressen organisierte. Anfang 1955 präsentierte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Instruktionen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Die Geschichte des Compilerbaus wurde von den jeweils aktuellen Programmiersprachen und Hardwarearchitekturen geprägt. Weitere frühe Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler wurden aber erst in den 1960er Jahren entwickelt.

Schritt 1 - Passiv -> Aktiv

Die Mathematikerin Grace Hopper kreirte 1952 den ersten Compiler (A-0). Programmierer reihten ausschließlich Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand und damit Symbolik der Mathematik sowie natürliche Sprache für die Programmierung erschloss. Am 3. Mai 1952 stellte Hopper erstmals öffentlich den ersten Compiler A-0 vor, der Algorithmen aus einem Katalog abrief, Code umschrieb, in passender Sequenz zusammenstellte, Speicherplatz reservierte und die Zuteilung von Speicheradressen organisierte. Anfang 1955 präsentierte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Instruktionen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Die jeweils aktuellen Programmiersprachen und Hardwarearchitekturen prägten die Geschichte des Compilerbaus. Weitere frühe Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler entwickelten sich aber erst in den 1960er Jahren.

Schritt 2 - Fremdwörter ersetzen

Die Mathematikerin Grace Hopper entwickelte 1952 den ersten Compiler (A-0). Programmierer reihten ausschließlich Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand und damit Symbolik der Mathematik sowie natürliche Sprache für die Programmierung erschloss. Am 3. Mai 1952 stellte Hopper erstmals öffentlich den ersten Compiler A-0 vor, der Algorithmen aus einem Katalog abrief, Code umschrieb, in passender Reihenfolge zusammenstellte, Speicherplatz reservierte und die Zuteilung von Speicheradressen organisierte. Anfang 1955 zeigte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Anweisungen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Die jeweils aktuellen Programmiersprachen und Hardwarearchitekturen prägten die Geschichte des Compilerbaus. Weitere frühe Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler entwickelten sich aber erst in den 1960er Jahren.

Schritt 3 - Kurze Sätze

Die Mathematikerin Grace Hopper entwickelte 1952 den ersten Compiler (A-0). Programmierer reihten ausschließlich Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand. Dadurch erschloss sie Symbolik der Mathematik sowie natürliche Sprache für die Programmierung. Am 3. Mai 1952 stellte Hopper erstmals öffentlich den ersten Compiler A-0 vor, der

• Algorithmen aus einem Katalog abrief
• Code umschrieb
• in passender Reihenfolge zusammenstellte
• Speicherplatz reservierte und
• die Zuteilung von Speicheradressen organisierte.

Anfang 1955 zeigte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Anweisungen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Die jeweils aktuellen Programmiersprachen und Hardwarearchitekturen prägten die Geschichte des Compilerbaus. Weitere frühe Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler entwickelten sich aber erst in den 1960er Jahren.

Schritt 4 - Nullwörter & Sätze entfernen

Die Mathematikerin Grace Hopper entwickelte 1952 den ersten Compiler (A-0). Programmierer reihten Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand. Dadurch erschloss sie Symbolik der Mathematik sowie natürliche Sprache für die Programmierung. Am 3. Mai 1952 stellte Hopper den ersten Compiler A-0 öffentlich vor, der

• Algorithmen aus einem Katalog abrief
• Code umschrieb
• in passender Reihenfolge zusammenstellte
• Speicherplatz reservierte und
• die Zuteilung von Speicheradressen organisierte.

Anfang 1955 zeigte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Anweisungen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Weitere frühe Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler entwickelten sich aber erst in den 1960er Jahren.

Schritt 5 - Adjektive entfernen

Die Mathematikerin Grace Hopper entwickelte 1952 den ersten Compiler (A-0). Programmierer reihten Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand. Dadurch erschloss sie Symbolik der Mathematik sowie natürliche Sprache für die Programmierung. Am 3. Mai 1952 stellte Hopper den ersten Compiler A-0 öffentlich vor, der

• Algorithmen aus einem Katalog abrief
• Code umschrieb
• in Reihenfolge brachte
• Speicherplatz reservierte und
• die Zuteilung von Speicheradressen organisierte.

Anfang 1955 zeigte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Anweisungen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Weitere Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler entwickelten sich aber erst in den 1960er Jahren.

Schritt 6 - Anglizismen ersetzen

Die Mathematikerin Grace Hopper entwickelte 1952 den ersten Compiler (A-0). Programmierer reihten Nullen und Einsen aneinander, bis Grace Hopper den Compiler erfand. Dadurch erschloss sie Symbolik der Mathematik sowie natürliche Sprache für die Programmierung. Am 3. Mai 1952 stellte Hopper den ersten Compiler A-0 öffentlich vor, der

• Algorithmen aus einem Katalog abrief
• Code umschrieb
• in Reihenfolge brachte
• Speicherplatz reservierte und
• die Zuteilung von Speicheradressen organisierte.

Anfang 1955 zeigte Hopper bereits einen Prototyp des Compilers B-0, der nach englischen, französischen oder deutschen Anweisungen Programme erzeugte. Hopper nannte ihren Vortrag zum ersten Compiler „The Education of a Computer“.

Weitere Meilensteine sind 1957 der erste FORTRAN-Compiler und 1960 der erste COBOL-Compiler. Viele Architekturmerkmale heutiger Compiler entwickelten sich aber erst in den 1960er Jahren.

Sonstiges

Umstellen -> "Education of a Computer"-Satz vor die Liste

Text neu schreiben

• Gliederung - Was will ich eigentlich sagen?
  • Wer ist mein Publikum?
  • Witzigkeit! (Witzige Beispiele)
• Satzfetzen, Links, copy+paste
• Ausformulieren - grob
  • Ersten Absatz streichen
• Pro Paragraph ein Gedanke -> rumschieben
• Feinschliff:

Mögliche Übungsaufgaben: Wie entstand die Brony-Bewegung; Geschichte Deiner Lieblingsprogrammiersprache; ...