tämä luokka tarjoaa sinulle monia mahdollisuuksia harjoitella teknisen esseen kirjoittamista. Seuraavassa on muutamia yksinkertaisia ohjeita, joiden avulla voit välttää yleisiä ongelmia.
nimeä essee sen aiheen mukaan (ei sen päivämäärän mukaan).
techfolio template esseetiedostot on nimetty niiden luomispäivämäärällä (ts.2015-08-26.md). Älä tee tätä: nimeä jokainen essee tiedosto vastaamaan sen aihe. Voit esimerkiksi perustaa tiedoston nimen esseesi otsikkoon. Jos esseesi otsikko on ”tulen sytyttäminen”, tiedostosi nimi voi olla ”igniting-the-fire.md”.
älä sisällä välilyöntejä tiedoston nimessä: käytä ”igniting-the-fire.md”, ei ”sytyttäminen fire.md”.
jos selain lataa tiedostoa sen näyttämisen sijaan, se johtuu todennäköisesti siitä, että tiedoston nimi ei pääty sanaan ”.md”.
oikea nimeäminen on tärkeää, jotta esseeseesi liittyvä URL on helppolukuinen ja antaa osviittaa sen aiheesta.
Älä koskaan käytä ”reflect” tai ”reflections” osana tiedostonimeä.
luo kiinnostava otsikko, joka piirtää lukijaan.
älä nimeä essettäsi moduulin nimellä (eli ”konfiguraationhallinta”) tai kokemusnimellä (eli ”Reflections on Javascript”). Hakukoneet korostavat usein sivujen otsikkoa. Haluaisitko lukea esseen tuollaisen otsikon perusteella? Pienellä ajatuksella voit keksiä jotain henkilökohtaista (esim.” konfiguraationhallinnan katastrofi, joka melkein maksoi minulle työni”) tai nokkelaa (”et voi aina git mitä haluat”).
Älä koskaan käytä ”heijastuksia” tai ”heijastuksia” osana titteliäsi.
Käytä sopivaa oikeinkirjoitusta ja kielioppia
älä kirjoita sanoja väärin. Käytä sopivaa kielioppia. Jos et ole varma, käytä online työkaluja tarkistaa oikeinkirjoitus ja kielioppi ennen julkaisua.
Kirjoita maailmalle, ei professorille
vaikka monet esseesi perustuvat kokemuksiisi kotitehtävistä (eli kokemuksista), älä kirjoita essettäsi kuin se olisi yksityinen Sähköposti professorille, joka selittää tehtävän. Älä luo osioita vastaamaan jokaiseen” kysymyksiin ” promptista. Jos teet niin, luot lähes varmasti tylsän esseen, joka ei ole kiinnostavaa luettavaa.
kirjoita sen sijaan se ”maailmalle”. Oletetaan, että joku satunnainen tekninen ammattilainen on googlannut ja esseesi tuli. Tee essee itsenäinen, itsestään selvä, ja hyödyllinen, että satunnainen ammattilainen. Minimoi oletukset, jotka teet kyseisen henkilön ohjelmistotekniikan taustasta (saati heidän taustastaan tässä luokassa!) Anna linkkejä taustamateriaaliin, jos se on hyödyllistä.
sen lisäksi, että sitä pitäisi kirjoittaa monelle ihmiselle, sitä pitäisi kirjoittaa moneen kertaan. Toisin sanoen, yritä kirjoittaa esseesi niin, että jos joku lukee sen vuoden päästä, se antaa silti arvokasta tietoa. Jos olet aloittelija aihe, kirjoita se antaa tietoa ja ymmärrystä muille aloittelijoille.
jotta esseestä tulisi vakuuttava, on yleensä hyödyllistä ”kertoa tarina”. Luo kerronta, älä vain vastaa kysymyksiin.
Format code appropriate
varmista, että koodi näkyy oikein lähetyksessäsi. Voit saavuttaa tämän käyttämällä aidattu koodi lohkojen ja syntaksin korostus. Tässä esimerkki javascript – koodin korostuksesta :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}mieti huolellisesti ennen kuin lisäät suuria koodinpätkiä (yli, sano 50 riviä). Nyrkkisääntönä on pitää koodinpätkät kohtuullisen pituisina ja varmistaa, että kaikki koodi liittyy suoraan esseesi aiheeseen.
käytä sisäisiä otsikoita esseesi jäsentämiseen
hyvillä esseillä on jonkinlainen sisäinen rakenne. Auta lukijaa ymmärtämään tämä rakenne tarjoamalla sisäisiä otsikoita. Älä aloita H1: llä (eli # Markdownissa), koska se on varattu virkasi otsikolle. Aloita sen sijaan H2: sta (## markdownissa) ja luo sen jälkeen alaluokat H3: lla (### markdownissa) jne.
käytä vastaavasti eriteltyjä tai luetteloituja luetteloita, taulukoita jne. tarpeen mukaan.
formaatti-ja attribuuttilainaukset
haluat toisinaan lainata toista kirjoittajaa teknisissä esseissäsi. Tämä sopii, kunhan et esitä noita sanoja ominasi.
Jos lainaat vain yhden lauseen tai kaksi, voit käyttää kursivointia, lainausmerkkejä ja ilmoittaa tekijän nimen. Esimerkiksi:
kuten Steve Jobs on todennut, ”Design ei ole vain sitä, miltä se näyttää ja tuntuu. Muotoilu toimii.”
pidemmissä lainauksissa käytetään <lohkokakkosta> ympäristöä yhdessä <alatunnisteen>kanssa. Esimerkiksi:
kyyninen nuori on lähes surullisin näky, koska se tarkoittaa sitä, että hän on muuttunut tietämättömyydestä ei-uskovaksi.
sisältävät kuvia tai muita medioita
kuten sanotaan, ” kuva on tuhannen sanan arvoinen.”Esseisiin on helppo sisällyttää kuvia ja videoita. Jos merkitys essee viestitään selkeämmin kuvia, ota aikaa löytää ja sisällyttää ne. Katso Techfolion käyttöohjeen muotoilu-osiosta ohjeet kuvien ja videoiden sisällyttämiseen.
älä ole tylsä, älä ole sopimaton
vain siksi, että essee on luonteeltaan tekninen, sen ei tarvitse olla tylsä. Yritä pistää persoonallisuutesi kirjoitukseesi. Voi olla ”nokkelia” nimikkeitä, popkulttuuriviittauksia ja niin edelleen.
sen sijaan nokkeluudella ei kannata mennä yli laidan. Kysy itseltäsi: nolostuisinko, jos äitini lukisi tämän esseen? (Koska hän saattaa.) Nolottaisiko, jos mahdollinen työnantaja lukisi tämän esseen? (Koska hän saattaa.)
tavoitteena on olla luova, näyttää hieman persoonallisuutta ja tehdä esseestä hauska lukea sekä informatiivinen.
älä kirjoita sitä viime hetkellä
esseidesi laatu nousee huomattavasti, jos kehität ne seuraavasti:
- Kirjoita ensimmäinen luonnos.
- tee jotain muuta 4 tuntia.
- tule takaisin ja tee editointisyöttö ensimmäisen luonnoksen päälle.
editointipassissa on yleensä paljon ongelmia ja sen avulla voi hioa ajatuksiaan merkittävästi, kunhan on astunut sivuun esseestä riittävän pitkäksi aikaa, jotta voi itse nähdä sen ”tuorein silmin”. Paras tapa tehdä se on nukkua yön yli, mutta jos sinulla ei ole niin paljon aikaa, niin tee ainakin jotain erilaista muutaman tunnin ajan. Näin alitajuntasi pääsee työstämään materiaalia.
Tarkista postauksesi sisältö ja ulkonäkö
kun olet kirjoittanut ja julkaissut sen, hae se selaimeen ja katso miltä se näyttää.
yksi kappale ei riitä
kahden tai kolmen lauseen esseen kirjoittaminen siinä toivossa, että saisi osittaista luottoa, ei ole hyvä strategia. Ensinnäkin, tällainen essee heijastaa huonommin ammatillista persoona kuin ei essee ollenkaan. Toiseksi, meillä on tapana antaa nolla pistettä esseistä, jotka heijastavat hyvin vähän vaivaa.
Hyödynnä UH Manoa Writing Center
UHM Writing Center tarjoaa konsultteja, jotka on koulutettu auttamaan kaikissa kirjoitusprosessin vaiheissa; olitpa vasta aloittamassa, tarkistamassa luonnosta tai jossain välissä.
voit varata enintään kaksi ajanvarausta viikossa sekä kolme ajanvarausta viikossa.