denne klassen vil gi deg mange muligheter til å praktisere kunsten teknisk essayskriving. Her er noen enkle retningslinjer du kan bruke for å unngå vanlige problemer.
Navngi essayfilen i henhold til emnet (ikke datoen).
techfolio template essay-filene er navngitt med datoen de ble opprettet (dvs.2015-08-26.md). Ikke gjør dette: navn hver essayfil for å gjenspeile emnet. Du kan for eksempel basere filnavnet på tittelen på essayet ditt. Hvis essaytittelen din Er «Tenning av brannen», kan filnavnet ditt være «igniting-the-fire.md».
ikke ta med mellomrom i filnavnet: bruk «igniting-the-fire.md», ikke «tenner fire.md».
hvis nettleseren laster ned filen i stedet for å vise den, er det sannsynligvis fordi filnavnet ikke slutter med». md».
Korrekt navngivning er viktig, slik AT NETTADRESSEN som er knyttet til essayet ditt, er lett å lese og gir en indikasjon på emnet.
bruk aldri «reflect» eller «reflections» som en del av filnavnet ditt.
Lag en interessant tittel som trekker i leseren.
ikke navngi essayet ditt med modulnavnet (Dvs.» Konfigurasjonsstyring») eller opplevelsesnavnet (dvs.»Refleksjoner På Javascript»). Søkemotorer legger ofte vekt på tittelen på sider. Vil du lese et essay basert på en tittel som det? Med litt tanke kan du komme opp med noe personlig (dvs. «konfigurasjonsstyringskatastrofen som nesten kostet meg jobben min») eller smart («Du kan ikke alltid git hva du vil»).
bruk aldri «reflect» eller «reflections» som en del av tittelen din.
Bruk riktig stavemåte og grammatikk
ikke skriv feil ord. Bruk riktig grammatikk. Hvis du ikke er sikker, benytte deg av elektroniske verktøy for å kontrollere staving og grammatikk før publisering.
Skriv for verden, Ikke professoren
selv om mange av dine essays vil være basert på dine erfaringer med hjemmeoppgaver (dvs.erfaringer), skriv ikke essayet ditt som det hvis det var en privat e-post til professoren som forklarer oppgaven. Ikke opprett seksjoner for å svare på hvert av «spørsmålene» fra spørringen. Hvis du gjør det, vil du nesten helt sikkert lage et kjedelig essay som ikke er interessant å lese.
i Stedet skriver du det «for verden». Anta at noen tilfeldige tekniske profesjonelle har googlet og essayet ditt kom opp. Gjør essayet selvstendig, selvforklarende og nyttig for den tilfeldige profesjonelle. Minimer forutsetningene du gjør om den personens software engineering bakgrunn (mye mindre deres bakgrunn i denne klassen!) Gi lenker til bakgrunnsmateriale hvis det er nyttig.
Ikke bare bør du skrive det for en rekke mennesker, du bør skrive det for en rekke ganger. Med andre ord, prøv å skrive essayet ditt slik at hvis noen leser det om et år, vil det fortsatt gi informasjon av verdi. Hvis du er nybegynner til emnet, skriv det for å gi innsikt og forståelse til andre nybegynnere.
For å gjøre et essay overbevisende, er det vanligvis nyttig å «fortelle en historie». Lag en fortelling, ikke bare svar på spørsmål.
Formatkode riktig
Kontroller at koden vises riktig i innlegget ditt. Du oppnår dette ved å bruke inngjerdede kodeblokker og syntaksutheving. Her er et eksempel på javascript-kode utheving :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}Tenk nøye før du inkluderer store kodebiter (utover, si 50 linjer). Som en tommelfingerregel, hold kodebiter til en rimelig lengde og sørg for at all koden er direkte relatert til emnet i essayet ditt.
Bruk interne overskrifter for å strukturere essayet ditt
Gode essays har en slags intern struktur. Hjelp leseren å forstå denne strukturen ved å gi interne overskrifter. Ikke start Med H1 (dvs. # I Markdown), da det er reservert for tittelen på innlegget ditt. I stedet, start Med H2 (## i markdown), og opprett deretter underavsnitt i den delen Med H3 (### i markdown), etc.
På samme måte kan du Bruke spesifiserte eller nummererte lister, tabeller osv.
Format og attributt sitater
du vil av Og til ønske å sitere en annen forfatter i dine tekniske essays. Dette er greit så lenge du ikke presenterer disse ordene som dine egne.
hvis du bare citerer en enkelt setning eller to, kan du bare bruke kursiv, anførselstegn og gi forfatterens navn. For eksempel:
Som bemerket Av Steve Jobs, » Design er Ikke bare Hva Det ser ut og føles som. Design er hvordan det fungerer.»
for lengre anførselstegn, bruk <blockquote > miljø sammen med < bunntekst>. For eksempel:
en kynisk ung person er nesten det tristeste synet å se, fordi det betyr at han eller hun har gått fra å vite ingenting til å tro ingenting.
Inkluder bilder eller andre medier
som de sier, » et bilde er verdt tusen ord.»Det er veldig enkelt å inkludere bilder og videoer i essayene dine. Hvis meningen med essayet ditt blir kommunisert tydeligere med bilder, ta deg tid til å finne og inkludere dem. Se Formatering-delen i Brukerhåndboken For TechFolio for instruksjoner om hvordan du inkluderer bilder og video.
Ikke vær kjedelig, ikke vær upassende
Bare fordi essayet er teknisk i naturen, trenger det ikke å være kjedelig. Prøv å injisere din personlighet i skrivingen din. Du kan ha «smarte» titler, popkultur referanser, og så videre.
På den annen side, ikke gå overbord på klokskapen. Spør deg selv: ville jeg bli flau hvis min mor leser dette essayet? (Fordi hun kan. Ville jeg bli flau hvis en potensiell arbeidsgiver leser dette essayet ? (Fordi hun kan.)
målet er å være kreativ, å vise litt personlighet, og å gjøre essayet morsomt å lese så vel som informativt.
ikke skriv det i siste øyeblikk
kvaliteten på essayene dine vil stige betydelig hvis du utvikler dem som følger:
- Skriv det første utkastet.
- Gjør noe annet i 4 timer.
- Kom tilbake og gjør et redigeringspass over det første utkastet.
redigeringspasset vil normalt få mange problemer og tillate deg å avgrense tankene dine betydelig, så lenge du har gått bort fra essayet i tilstrekkelig tid til å tillate deg å se det med «friske øyne». Den beste måten å gjøre det på er å sove på det over natten, men hvis du ikke har så mye tid, så gjør du i det minste noe annet i noen timer. Dette lar underbevisstheten gå på jobb på materialet.
Gjennomgå innleggets innhold og utseende
når du har skrevet og publisert det, kan du hente det i en nettleser og se hvordan det ser ut.
Ett avsnitt er ikke nok
Skrive en to eller tre setning essay i håp om å få noen delvis kreditt er ikke en god strategi. For en ting reflekterer et slikt essay mer dårlig på din profesjonelle persona enn ingen essay i det hele tatt. For en annen ting har vi en tendens til å tildele null poeng for essays som gjenspeiler svært liten innsats.
Benytt deg AV Uh Manoa Writing Center
UHM Writing Center gir konsulenter som er opplært til å hjelpe i alle stadier av skriveprosessen; enten du bare er i gang, reviderer et utkast, eller på et tidspunkt i mellom.
du kan planlegge opptil to avtaler per uke, samt tre walk-in avtaler per uke.