denne klasse vil give dig mange muligheder for at øve kunsten at teknisk essay skriftligt. Her er nogle enkle retningslinjer, du kan bruge til at undgå almindelige problemer.
navngiv essayfilen i henhold til dens emne (ikke dens dato).
techfolio skabelon essay filer er navngivet med den dato, de blev oprettet (dvs 2015-08-26.md). gør ikke dette: navngiv hver essaysfil for at afspejle dens emne. For eksempel kan du basere filnavnet på titlen på dit essay. Hvis dit essay titel er “antænde ilden”, så dit filnavn kan være “igniting-the-fire.md”.
Medtag ikke mellemrum i filnavnet: brug “igniting-the-fire.md”, ikke “antænde fire.md”.
hvis bro.sereren henter filen i stedet for at vise den, skyldes det sandsynligvis, at filnavnet ikke slutter med”. md”.
korrekt navngivning er vigtig, så URL ‘ en, der er knyttet til dit essay, er let at læse og giver en indikation af dens emne.
Brug aldrig “reflect” eller “reflections” som en del af dit filnavn.
Opret en interessant titel, der trækker i læseren.
navngiv ikke dit essay med modulnavnet (dvs. “konfigurationsstyring”) eller oplevelsesnavnet (dvs. “refleksioner om Javascript”). Søgemaskiner lægger ofte vægt på sidernes Titel. Vil du læse et essay baseret på en sådan titel? Jeg ville helt sikkert ikke. med en lille smule tanke kan du komme med noget personligt (dvs. “konfigurationsstyringskatastrofen, der næsten kostede mig mit job”) eller Smart (“du kan ikke altid git hvad du vil”).
Brug aldrig “reflect” eller “reflections” som en del af din titel.
Brug passende stavemåde og grammatik
skriv ikke ord forkert. Brug passende grammatik. Hvis du ikke er sikker, benytte dig af online værktøjer til at kontrollere stavning og grammatik før offentliggørelse.
Skriv for verden, ikke professoren
selvom mange af dine essays vil være baseret på dine oplevelser med hjemmeopgaver (dvs.oplevelser), skriv ikke dit essay, som det var en privat e-mail til professoren, der forklarede opgaven. Opret ikke sektioner for at besvare hvert af “spørgsmålene” fra prompten. Hvis du gør det, vil du næsten helt sikkert oprette et kedeligt essay, der ikke er interessant at læse.
skriv det i stedet “for verden”. Antag, at en tilfældig teknisk professionel har googlet, og dit essay kom op. Gør essayet selvstændigt, selvforklarende og nyttigt for den tilfældige professionelle. Minimer de antagelser, du laver om den pågældende persons programmetekniske baggrund (meget mindre deres baggrund i denne klasse!) Giv links til baggrundsmateriale, hvis det er nyttigt.
ikke kun skal du skrive det til en række mennesker, du skal skrive det i forskellige tider. Med andre ord, prøv at skrive dit essay sådan, at hvis nogen læser det om et år, vil det stadig give oplysninger om værdi. Hvis du er nybegynder til emnet, så skriv det for at give indsigt og forståelse til andre nybegyndere.
for at gøre et essay overbevisende er det normalt nyttigt at “fortælle en historie”. Opret en fortælling, svar ikke bare på spørgsmål.
formater kode korrekt
sørg for, at koden vises korrekt i dit indlæg. Du opnå dette ved hjælp af indhegnet kode blokke og syntaksfremhævning. Her er et eksempel på Javascript-kode fremhævning :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}tænk grundigt over, før du inkluderer store kodestykker (ud over, siger 50 linjer). Som tommelfingerregel skal du holde kodestykker i en rimelig længde og sørge for, at al koden er direkte relateret til emnet i dit essay.
brug interne overskrifter til at strukturere dit essay
gode essays har en slags intern struktur. Hjælp læseren med at forstå denne struktur ved at angive interne overskrifter. Start ikke med H1 (dvs. # i markering), da det er forbeholdt titlen på dit indlæg. Start i stedet med H2 (## i markering), og opret derefter underafsnit i det afsnit med H3 (### i markering) osv.
brug ligeledes specificerede eller opregnede lister, tabeller osv.
format og attribut citater
du vil lejlighedsvis gerne citere en anden forfatter i dine tekniske essays. Dette er fint, så længe du ikke præsenterer disse ord som dine egne.
hvis du bare citerer en enkelt sætning eller to, kan du blot bruge kursiv, anførselstegn og angive forfatterens navn. For eksempel:
som bemærket af Steve Jobs, “Design er ikke bare, hvordan det ser ud og føles. Design er, hvordan det fungerer.”
For længere citater, brug <Blokcitat> miljø sammen med <sidefod>. For eksempel:
en kynisk ung person er næsten det tristeste syn at se, fordi det betyder, at han eller hun er gået fra at vide intet til at tro intet.
Inkluder billeder eller andre medier
som de siger, “et billede er tusind ord værd.”Det er meget nemt at medtage billeder og videoer i dine essays. Hvis betydningen af dit essay vil blive kommunikeret tydeligere med billeder, skal du tage dig tid til at finde og inkludere dem. Se afsnittet formatering i brugervejledningen til TechFolio for instruktioner om, hvordan du inkluderer billeder og video.
vær ikke kedelig, vær ikke upassende
bare fordi essayet er teknisk, behøver det ikke at være kedeligt. Prøv at injicere din personlighed i din skrivning. Du kan have “kloge” titler, popkulturreferencer og så videre.
på den anden side, ikke gå overbord på klogskab. Spørg dig selv: ville jeg være flov, hvis min mor læste dette essay? (Fordi hun måske.) Ville jeg være flov, hvis en potentiel arbejdsgiver læste dette essay? (Fordi hun måske.)
målet er at være kreativ, at vise en vis personlighed og gøre essayet sjovt at læse såvel som informativt.
skriv det ikke i sidste øjeblik
kvaliteten af dine essays vil stige væsentligt, hvis du udvikler dem som følger:
- skriv det første udkast.
- gør noget andet i 4 timer.
- kom tilbage og lav et redigeringspas over det første kladde.
redigeringspasset fanger normalt mange problemer og giver dig mulighed for at forfine dine tanker markant, så længe du er gået væk fra essayet i tilstrækkelig tid til at give dig selv mulighed for at se det med “friske øjne”. Den bedste måde at gøre det på er at sove på det natten over, men hvis du ikke har så meget tid, skal du i det mindste gøre noget andet i et par timer. Dette lader din underbevidsthed gå på arbejde med materialet.
gennemgå dit indlægs indhold og udseende
når du har skrevet og offentliggjort det, skal du hente det i en bro.ser og se, hvordan det ser ud.
et afsnit er ikke nok
at skrive et essay med to eller tre sætninger i håb om at få en delvis kredit er ikke en god strategi. For det første afspejler et sådant essay dårligere på din professionelle persona end intet essay overhovedet. For en anden ting har vi en tendens til at tildele nul point for essays, der afspejler meget lidt indsats.
Gør brug af Uh Manoa Skrivecenter
UHM Skrivecenter giver konsulenter, der er uddannet til at hjælpe i alle faser af skriveprocessen; uanset om du lige er i gang, reviderer et udkast eller på et tidspunkt imellem.
du kan planlægge op til to aftaler om ugen samt tre aftaler om ugen.