deze cursus biedt u vele mogelijkheden om de kunst van het technisch essay schrijven te oefenen. Hier zijn enkele eenvoudige richtlijnen die u kunt gebruiken om veelvoorkomende problemen te voorkomen.
geef het essaybestand een naam volgens het onderwerp (niet de datum).
de techfolio template essay bestanden worden genoemd met de datum waarop ze zijn gemaakt (i. e. 2015-08-26.md). doe dit niet: noem elk essay bestand om het onderwerp weer te geven. U kunt bijvoorbeeld de bestandsnaam baseren op de titel van uw essay. Als uw essay titel is “ontsteken van het vuur”, dan is uw bestandsnaam zou kunnen zijn “igniting-the-fire.md”.
geen spaties in de bestandsnaam opnemen: gebruik “igniting-the-fire.md”, niet “ontsteken van de fire.md”.
als de browser het bestand downloadt in plaats van het weer te geven, is dat waarschijnlijk omdat de bestandsnaam niet eindigt met”. md”.
correcte naamgeving is belangrijk, zodat de URL die aan uw essay is gekoppeld gemakkelijk leesbaar is en een indicatie geeft van het onderwerp.
gebruik nooit ” reflect “of” reflections ” als onderdeel van uw bestandsnaam.
Maak een interessante titel die de lezer trekt.
geef uw essay geen naam met de modulenaam (d.w.z. “Configuration Management”) of de ervaringsnaam (d.w.z.”Reflections on Javascript”). Zoekmachines benadrukken vaak de titel van pagina ‘ s. Wil je een essay lezen gebaseerd op zo ‘ n titel? Met een beetje nadenken kun je met iets persoonlijks komen (dat wil zeggen “de catastrofe van het Configuratiebeheer die me bijna mijn baan kostte”) of slim (“je kunt niet altijd git wat je wilt”).
gebruik nooit ” reflect “of” reflections ” als onderdeel van uw titel.
gebruik de juiste spelling en grammatica
spell geen woorden verkeerd in. Gebruik de juiste grammatica. Als u niet zeker bent, maak dan gebruik van online tools om de spelling en grammatica te controleren voorafgaand aan de publicatie.
schrijf voor de wereld, niet voor de professor
hoewel veel van uw essays gebaseerd zullen zijn op uw ervaringen met het doen van thuisopdrachten (d.w.z. ervaringen), schrijf uw essay niet als het ware een privé-e-mail aan de professor waarin de opdracht wordt uitgelegd. Maak geen secties om elk van de “vragen” van de prompt te beantwoorden. Als je dat doet, zal je bijna zeker een saai essay maken dat niet interessant is om te lezen.
schrijf het in plaats daarvan “voor de wereld”. Neem aan dat een willekeurige technische professional is googlen en uw essay kwam. Maak het essay self-contained, zelfverklarend, en nuttig voor die willekeurige professional. Minimaliseer de veronderstellingen die je maakt over de software engineering achtergrond van die persoon (veel minder hun achtergrond in deze klasse!) Geef links naar achtergrondmateriaal indien nuttig.
schrijf het niet alleen voor een verscheidenheid van mensen, je moet het schrijven voor een verscheidenheid van tijden. Met andere woorden, probeer je essay zo te schrijven dat als iemand het in een jaar leest, het nog steeds waardevolle informatie zal opleveren. Als je een newbie aan het onderwerp, schrijf het dan om inzicht en begrip te bieden aan andere newbies.
om een essay overtuigend te maken, is het meestal nuttig om “een verhaal te vertellen”. Maak een verhaal, beantwoord niet alleen vragen.
formaat code correct
zorg ervoor dat de code correct wordt weergegeven in uw bericht. U bereikt dit met omheinde codeblokken en syntaxismarkering. Hier is een voorbeeld van JavaScript-code markeren :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}denk goed na voordat u grote codefragmenten toevoegt (verder, zeg 50 regels). Als vuistregel houdt u codefragmenten redelijk lang en zorgt u ervoor dat alle code direct gerelateerd is aan het onderwerp van uw essay.
gebruik interne koppen om uw essay te structureren
goede essays hebben een soort interne structuur. Help de lezer deze structuur te begrijpen door interne koppen aan te bieden. Begin niet met H1 (dus # in Markdown), want dat is gereserveerd voor de titel van je bericht. Begin in plaats daarvan met H2 (## in markdown), maak dan subsecties binnen die sectie met H3 (### in markdown), enz.
gebruik ook gespecificeerde of opgesomde lijsten, tabellen, enz.
formaat en attribuut aanhalingstekens
af en toe wilt u een andere schrijver citeren in uw technische essays. Dit is prima zolang je die woorden niet als je eigen woorden presenteert.
als u slechts een enkele zin of twee citeert, kunt u gewoon cursief, aanhalingstekens en de naam van de auteur opgeven. Bijvoorbeeld:
zoals Steve Jobs opmerkte, ” Design is niet alleen wat het eruit ziet en voelt. Design is hoe het werkt.”
gebruik voor langere aanhalingstekens de omgeving <blockquote> samen met<footer >. Bijvoorbeeld:
een cynische jongere is bijna het droevigste gezicht om te zien, omdat het betekent dat hij of zij is gegaan van het weten van niets naar het geloven van niets.
inclusief afbeeldingen of andere media
zoals ze zeggen: “een afbeelding is duizend woorden waard.”Het is heel gemakkelijk om foto’ s en video ‘ s in je essays op te nemen. Als de Betekenis van uw essay duidelijker wordt gecommuniceerd met beelden, neem dan de tijd om ze te vinden en op te nemen. Zie het gedeelte opmaak van de Techfolio Gebruikershandleiding voor instructies over het opnemen van afbeeldingen en video ‘ s.
wees niet saai, wees niet ongepast
alleen omdat het essay technisch van aard is, hoeft het niet saai te zijn. Probeer je persoonlijkheid te injecteren in je schrijven. Je kunt “slimme” titels hebben, popcultuur referenties, enzovoort.
aan de andere kant, ga niet te ver over de slimheid. Vraag jezelf af: zou ik me schamen als mijn moeder dit essay zou lezen? Omdat ze dat zou kunnen. Zou ik me schamen als een potentiële werkgever dit essay leest? Omdat ze dat zou kunnen.)
het doel is creatief te zijn, persoonlijkheid te tonen en het essay zowel leuk om te lezen als informatief te maken.
schrijf het niet op het laatste moment
de kwaliteit van uw essays zal aanzienlijk stijgen als u ze als volgt ontwikkelt:
- schrijf het eerste ontwerp.
- doe iets anders gedurende 4 uur.
- kom terug en doe een editing pass over het eerste ontwerp.
de editing pass zal normaal gesproken veel problemen opleveren en stelt u in staat om uw gedachten aanzienlijk te verfijnen, zolang u voldoende tijd uit het essay bent gestapt om het met “frisse ogen”te kunnen zien. De beste manier om dat te doen is om er een nachtje over te slapen, maar als je niet zoveel tijd hebt, doe dan tenminste een paar uur iets anders. Dit laat je onderbewustzijn gaan werken aan het materiaal.
bekijk de inhoud en het uiterlijk van uw bericht
nadat u het hebt geschreven en gepubliceerd, haalt u het op in een browser en ziet u hoe het eruit ziet.
een alinea is niet genoeg
het schrijven van een essay met twee of drie zinnen in de hoop gedeeltelijk krediet te krijgen is geen goede strategie. Voor een ding, zo ‘ n essay weerspiegelt slechter op uw professionele persona dan geen essay helemaal. Voor een ander ding, we hebben de neiging om nul punten voor essays die zeer weinig inspanning weerspiegelen toekennen.
maak gebruik van het UH Manoa Writing Center
het UHM Writing Center biedt consultants die zijn opgeleid om te helpen in alle stadia van het schrijfproces; of u nu net begonnen bent, een ontwerp aan het herzien bent, of ergens daartussen.
u kunt maximaal twee afspraken per week en drie inloopafspraken per week plannen.