denna klass kommer att ge dig många möjligheter att öva konsten att teknisk uppsatsskrivning. Här är några enkla riktlinjer som du kan använda för att undvika vanliga problem.
namnge uppsatsfilen enligt ämnet (inte dess datum).
techfolio – malluppsatsfilerna namnges med det datum de skapades (dvs. 2015-08-26.md). gör inte detta: namnge varje uppsatsfil för att återspegla dess ämne. Du kan till exempel basera filnamnet på titeln på din uppsats. Om din uppsats titel är ”tända elden”, då ditt filnamn kan vara ”igniting-the-fire.md”.
inkludera inte mellanslag i filnamnet: använd ”igniting-the-fire.md”, inte ”antända fire.md”.
om webbläsaren laddar ner filen istället för att visa den beror det förmodligen på att filnamnet inte slutar med ”.md”.
korrekt namngivning är viktigt så att webbadressen som är associerad med din uppsats är lätt att läsa och ger en indikation på dess ämne.
Använd aldrig ”reflektera” eller ”reflektioner” som en del av ditt filnamn.
skapa en intressant titel som drar in läsaren.
namnge inte din uppsats med modulnamnet (dvs. ”konfigurationshantering”) eller erfarenhetsnamnet (dvs. ”reflektioner om Javascript”). Sökmotorer betonar ofta sidans titel. Vill du läsa en uppsats baserad på en sådan titel? Med lite tanke kan du komma på något personligt (dvs ”konfigurationshanteringskatastrofen som nästan kostade mig mitt jobb”) eller smart (”Du kan inte alltid git vad du vill”).
Använd aldrig ”reflektera” eller ”reflektioner” som en del av din titel.
Använd lämplig stavning och grammatik
skriv inte fel ord. Använd lämplig grammatik. Om du inte är säker, utnyttja onlineverktyg för att kontrollera stavning och grammatik före publicering.
Skriv för världen, inte professorn
även om många av dina uppsatser kommer att baseras på dina erfarenheter som gör hemuppgifter (dvs. erfarenheter), skriv inte din uppsats som om det var ett privat e-postmeddelande till professorn som förklarar uppdraget. Skapa inte avsnitt för att svara på var och en av ”frågorna” från prompten. Om du gör det kommer du nästan säkert att skapa en tråkig uppsats som inte är intressant att läsa.
skriv istället det ”för världen”. Antag att någon slumpmässig teknisk professionell har googlat och din uppsats kom upp. Gör uppsatsen fristående, självförklarande och användbar för den slumpmässiga professionella. Minimera de antaganden du gör om den personens programvaruteknik bakgrund (mycket mindre deras bakgrund i den här klassen!) Ge länkar till bakgrundsmaterial om det är användbart.
inte bara bör du skriva det för en mängd olika människor, du bör skriva det för en mängd olika gånger. Med andra ord, försök att skriva din uppsats så att om någon läser den om ett år, kommer den fortfarande att ge information av värde. Om du är nybörjare i ämnet, skriv det för att ge insikt och förståelse för andra nybörjare.
för att göra en uppsats övertygande är det vanligtvis bra att ”berätta en historia”. Skapa en berättelse, svara inte bara på frågor.
formatera koden på lämpligt sätt
se till att koden visas korrekt i ditt inlägg. Du åstadkommer detta genom att använda inhägnade kodblock och syntaxmarkering. Här är ett exempel på javascript-kodmarkering :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}Tänk noga innan du inkluderar stora kodavsnitt (bortom, säg 50 rader). Som tumregel ska du hålla kodavsnitt till en rimlig längd och se till att all kod är direkt relaterad till ämnet för din uppsats.
använd interna rubriker för att strukturera din uppsats
bra uppsatser har någon form av intern struktur. Hjälp läsaren att förstå denna struktur genom att tillhandahålla interna rubriker. Börja inte med H1 (dvs # i Markdown), eftersom det är reserverat för titeln på ditt inlägg. Börja istället med H2 (## i wiki) och skapa sedan underavsnitt inom det avsnittet med H3 (### i wiki) etc.
på samma sätt använder specificerade eller uppräknade listor, tabeller, etc som är lämpligt.
Format och attribut citat
du kommer ibland vill citera en annan författare i dina tekniska essäer. Det här är bra så länge du inte presenterar dessa ord som dina egna.
om du bara citerar en enda mening eller två kan du helt enkelt använda kursiv, citattecken och ange författarens namn. Till exempel:
som noterat av Steve Jobs, ”Design är inte bara hur det ser ut och känns som. Design är hur det fungerar.”
för längre citat, använd < blockquote>miljö tillsammans med <sidfot>. Till exempel:
en cynisk ung person är nästan den sorgligaste synen att se, för det betyder att han eller hon har gått från att veta ingenting till att tro ingenting.
inkludera bilder eller andra medier
som de säger, ”en bild säger mer än tusen ord.”Det är väldigt enkelt att inkludera bilder och videor i dina uppsatser. Om meningen med din uppsats kommer att kommuniceras tydligare med bilder, ta dig tid att hitta och inkludera dem. Se avsnittet formatering i TechFolio Användarhandbok för instruktioner om hur du inkluderar bilder och video.
var inte tråkig, var inte olämplig
bara för att uppsatsen är Teknisk i naturen behöver den inte vara tråkig. Försök att injicera din personlighet i ditt skrivande. Du kan ha ”smarta” titlar, popkulturreferenser och så vidare.
å andra sidan, gå inte överbord på smartheten. Fråga dig själv: skulle jag bli generad om min mamma läste denna uppsats? (För att hon kanske.) Skulle jag bli generad om en potentiell arbetsgivare läser denna uppsats? (För att hon kanske.)
målet är att vara kreativ, att visa lite personlighet och att göra uppsatsen rolig att läsa såväl som informativ.
skriv inte det i sista minuten
kvaliteten på dina uppsatser kommer att öka väsentligt om du utvecklar dem enligt följande:
- skriv det första utkastet.
- gör något annat i 4 timmar.
- kom tillbaka och gör ett redigeringspass över det första utkastet.
redigeringspasset kommer normalt att fånga många problem och låta dig förfina dina tankar avsevärt, så länge du har gått bort från uppsatsen i tillräckligt lång tid för att låta dig se det med ”färska ögon”. Det bästa sättet att göra det är att sova på det över natten, men om du inte har så mycket tid, gör åtminstone något annat i några timmar. Detta låter ditt undermedvetna gå till jobbet på materialet.
granska ditt inläggs innehåll och utseende
när du har skrivit och publicerat det, Hämta det i en webbläsare och se hur det ser ut.
ett stycke räcker inte
att skriva en uppsats med två eller tre meningar i hopp om att få delvis kredit är inte en bra strategi. För en sak, en sådan uppsats speglar mer dåligt på din professionella persona än ingen uppsats alls. För en annan sak tenderar vi att tilldela nollpoäng för uppsatser som speglar mycket liten ansträngning.
använd UH Manoa Writing Center
UHM Writing Center tillhandahåller konsulter som är utbildade för att hjälpa till i alla skeden av skrivprocessen; oavsett om du bara har börjat, reviderar ett utkast eller någon gång däremellan.
du kan schemalägga upp till två möten per vecka samt tre walk-in möten per vecka.