Dieser Kurs bietet Ihnen viele Möglichkeiten, die Kunst des technischen Essayschreibens zu üben. Hier sind einige einfache Richtlinien, die Sie verwenden können, um häufige Probleme zu vermeiden.
Benennen Sie die Essay-Datei nach ihrem Thema (nicht nach ihrem Datum).
Die Techfolio-Vorlagendateien werden mit dem Erstellungsdatum benannt (d. h 2015-08-26.md ). Tun Sie dies nicht: Benennen Sie jede Essay-Datei, um ihr Thema widerzuspiegeln. Sie können den Dateinamen beispielsweise auf den Titel Ihres Aufsatzes stützen. Wenn Ihr Aufsatztitel „Igniting the fire“ lautet, lautet Ihr Dateiname möglicherweise „igniting-the-fire.md „.
Schließen Sie keine Leerzeichen in den Dateinamen ein: use „igniting-the-fire.md „, nicht „zündet die fire.md „.
Wenn der Browser die Datei herunterlädt, anstatt sie anzuzeigen, liegt dies wahrscheinlich daran, dass der Dateiname nicht mit „.md“ endet.
Die korrekte Benennung ist wichtig, damit die mit Ihrem Aufsatz verknüpfte URL leicht lesbar ist und einen Hinweis auf den Gegenstand gibt.
Verwenden Sie niemals „reflect“ oder „reflections“ als Teil Ihres Dateinamens.
Erstellen Sie einen interessanten Titel, der den Leser anzieht.
Benennen Sie Ihren Aufsatz nicht mit dem Modulnamen (z. B. „Configuration Management“) oder dem Erfahrungsnamen (z. B. „Reflections on Javascript“). Suchmaschinen betonen oft den Titel von Seiten. Möchten Sie einen Aufsatz lesen, der auf einem solchen Titel basiert? Mit ein wenig Nachdenken können Sie sich etwas Persönliches (dh „Die Konfigurationsmanagement-Katastrophe, die mich fast meinen Job gekostet hat“) oder Cleveres („Sie können nicht immer git, was Sie wollen“) einfallen lassen.
Verwenden Sie niemals „reflect“ oder „reflections“ als Teil Ihres Titels.
Verwenden Sie geeignete Rechtschreibung und Grammatik
Wörter nicht falsch schreiben. Verwenden Sie eine geeignete Grammatik. Wenn Sie sich nicht sicher sind, nutzen Sie Online-Tools, um Rechtschreibung und Grammatik vor der Veröffentlichung zu überprüfen.
Schreiben Sie für die Welt, nicht für den Professor
Obwohl viele Ihrer Aufsätze auf Ihren Erfahrungen mit Hausarbeiten (dh Erfahrungen) basieren, schreiben Sie Ihren Aufsatz nicht wie eine private E-Mail an den Professor, in der die Aufgabe erläutert wird. Erstellen Sie keine Abschnitte, um jede der „Fragen“ an der Eingabeaufforderung zu beantworten. Wenn Sie das tun, werden Sie mit ziemlicher Sicherheit einen langweiligen Aufsatz erstellen, der nicht interessant zu lesen ist.
Schreiben Sie es stattdessen „für die Welt“. Angenommen, ein zufälliger technischer Fachmann hat gegoogelt und Ihr Aufsatz ist erschienen. Machen Sie den Aufsatz eigenständig, selbsterklärend und nützlich für diesen zufälligen Fachmann. Minimieren Sie die Annahmen, die Sie über den Software-Engineering-Hintergrund dieser Person treffen (geschweige denn ihren Hintergrund in dieser Klasse!) Geben Sie Links zu Hintergrundmaterial, wenn nützlich.
Du solltest es nicht nur für eine Vielzahl von Menschen schreiben, du solltest es für eine Vielzahl von Zeiten schreiben. Mit anderen Worten, versuchen Sie, Ihren Aufsatz so zu schreiben, dass er immer noch wertvolle Informationen liefert, wenn jemand ihn in einem Jahr liest. Wenn Sie ein Neuling in diesem Thema sind, schreiben Sie es, um anderen Neulingen Einsicht und Verständnis zu vermitteln.
Um einen Aufsatz überzeugend zu gestalten, ist es normalerweise hilfreich, „eine Geschichte zu erzählen“. Erstellen Sie eine Erzählung, beantworten Sie nicht nur Fragen.
Formatieren Sie den Code entsprechend
Stellen Sie sicher, dass der Code in Ihrem Beitrag ordnungsgemäß angezeigt wird. Sie erreichen dies, indem Sie eingezäunte Codeblöcke und Syntaxhervorhebungen verwenden. Hier ist ein Beispiel für die Hervorhebung von Javascript-Code :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}Denken Sie sorgfältig nach, bevor Sie große Codeausschnitte (über 50 Zeilen hinaus) einfügen. Halten Sie als Faustregel Code-Snippets auf eine angemessene Länge und stellen Sie sicher, dass der gesamte Code in direktem Zusammenhang mit dem Thema Ihres Aufsatzes steht.
Verwenden Sie interne Überschriften, um Ihren Aufsatz zu strukturieren
Gute Aufsätze haben eine Art interne Struktur. Helfen Sie dem Leser, diese Struktur zu verstehen, indem Sie interne Überschriften bereitstellen. Beginnen Sie nicht mit H1 (dh # in Markdown), da dies für den Titel Ihres Beitrags reserviert ist. Beginnen Sie stattdessen mit H2 (## in Markdown) und erstellen Sie dann Unterabschnitte innerhalb dieses Abschnitts mit H3 (### in Markdown) usw.
Verwenden Sie in ähnlicher Weise Einzellisten oder aufgezählte Listen, Tabellen usw.
Format- und Attributzitate
Sie werden gelegentlich einen anderen Autor in Ihren technischen Aufsätzen zitieren wollen. Dies ist in Ordnung, solange Sie diese Wörter nicht als Ihre eigenen darstellen.
Wenn Sie nur einen oder zwei Sätze zitieren, können Sie einfach Kursivschrift und Anführungszeichen verwenden und den Namen des Autors angeben. Zum Beispiel:
Wie Steve Jobs bemerkte: „Design ist nicht nur das, wie es aussieht und sich anfühlt. Design ist, wie es funktioniert.“
Verwenden Sie für längere Anführungszeichen die <blockquote> -Umgebung zusammen mit <footer>. Zum Beispiel:
Ein zynischer junger Mensch ist fast der traurigste Anblick, den man sehen kann, weil es bedeutet, dass er oder sie von nichts wissen zu nichts glauben gegangen ist.
Fügen Sie Bilder oder andere Medien hinzu
Wie sie sagen: „Ein Bild sagt mehr als tausend Worte.“ Es ist sehr einfach, Bilder und Videos in Ihre Essays aufzunehmen. Wenn die Bedeutung Ihres Essays klarer mit Bildern kommuniziert wird, nehmen Sie sich die Zeit, sie zu finden und einzubeziehen. Anweisungen zum Einbinden von Bildern und Videos finden Sie im Abschnitt Formatierung des TechFolio-Benutzerhandbuchs.
Sei nicht langweilig, sei nicht unangemessen
Nur weil der Aufsatz technischer Natur ist, muss er nicht langweilig sein. Versuchen Sie, Ihre Persönlichkeit in Ihr Schreiben einzubringen. Sie können „clevere“ Titel, Popkultur-Referenzen und so weiter haben.
Auf der anderen Seite, gehen Sie nicht über Bord auf die Klugheit. Fragen Sie sich: Wäre es mir peinlich, wenn meine Mutter diesen Aufsatz lesen würde? (Weil sie es könnte. Wäre es mir peinlich, wenn ein potenzieller Arbeitgeber diesen Aufsatz lesen würde? (Weil sie es könnte.)
Das Ziel ist es, kreativ zu sein, eine gewisse Persönlichkeit zu zeigen und den Aufsatz sowohl lesenswert als auch informativ zu machen.
Schreiben Sie es nicht in letzter Minute
Die Qualität Ihrer Aufsätze wird erheblich steigen, wenn Sie sie wie folgt entwickeln:
- Schreiben Sie den ersten Entwurf.
- Mach 4 Stunden lang etwas anderes.
- Kommen Sie zurück und bearbeiten Sie den ersten Entwurf.
Der Bearbeitungsdurchlauf wird normalerweise viele Probleme aufgreifen und es Ihnen ermöglichen, Ihre Gedanken erheblich zu verfeinern, solange Sie sich für eine ausreichende Zeit von dem Aufsatz entfernt haben, um ihn mit „frischen Augen“ sehen zu können. Der beste Weg, dies zu tun, besteht darin, über Nacht darauf zu schlafen, aber wenn Sie nicht so viel Zeit haben, tun Sie zumindest für ein paar Stunden etwas anderes. Dadurch kann Ihr Unterbewusstsein an dem Material arbeiten.
Überprüfen Sie den Inhalt und das Erscheinungsbild Ihres Beitrags
Sobald Sie ihn geschrieben und veröffentlicht haben, rufen Sie ihn in einem Browser ab und sehen Sie, wie er aussieht.
Ein Absatz reicht nicht aus
Es ist keine gute Strategie, einen Aufsatz mit zwei oder drei Sätzen zu schreiben, in der Hoffnung, einen Teilkredit zu erhalten. Zum einen spiegelt ein solcher Aufsatz Ihre berufliche Persönlichkeit schlechter wider als überhaupt kein Aufsatz. Zum anderen neigen wir dazu, Null Punkte für Aufsätze zu vergeben, die sehr wenig Aufwand widerspiegeln.
Nutzen Sie das UHM Writing Center
Das UHM Writing Center bietet Berater, die geschult sind, um in allen Phasen des Schreibprozesses zu helfen; ob Sie gerade erst anfangen, einen Entwurf überarbeiten oder irgendwann dazwischen.
Sie können bis zu zwei Termine pro Woche sowie drei begehbare Termine pro Woche vereinbaren.