această clasă vă va oferi multe oportunități de a practica arta scrierii eseului tehnic. Iată câteva linii directoare simple pe care le puteți utiliza pentru a evita problemele obișnuite.
denumiți fișierul eseu în funcție de subiectul său (nu de data sa).
fișierele eseu șablon techfolio sunt denumite cu data la care au fost create (adică 2015-08-26.md). nu faceți acest lucru: denumiți fiecare fișier eseu pentru a reflecta subiectul său. De exemplu, puteți baza numele fișierului pe titlul eseului. Dacă titlul eseului dvs. este „aprinderea focului”, atunci numele fișierului dvs. ar putea fi „igniting-the-fire.md”.
nu includeți spații în numele fișierului: utilizați „igniting-the-fire.md”, nu „aprinderea fire.md”.
dacă browserul descarcă fișierul în loc să-l afișeze, probabil că numele fișierului nu se termină cu „.md”.
denumirea corectă este importantă, astfel încât URL-ul asociat eseului dvs. să fie ușor de citit și să ofere o indicație a subiectului său.
nu folosiți niciodată „reflect” sau „reflecții” ca parte a numelui fișierului.
creați un titlu interesant care atrage cititorul.
nu denumiți eseul cu numele modulului (adică „managementul configurației”) sau numele experienței (adică „reflecții asupra Javascript”). Motoarele de căutare subliniază adesea titlul paginilor. Vrei să citești un eseu bazat pe un titlu ca acesta? Cu un pic de gândire, puteți veni cu ceva personal (adică „catastrofa de gestionare a configurației care aproape că m-a costat slujba”) sau inteligent („nu poți întotdeauna să git ceea ce vrei”).
nu folosiți niciodată „reflect” sau „reflecții” ca parte a titlului dvs.
folosiți ortografia și gramatica corespunzătoare
nu scrieți greșit cuvintele. Folosiți gramatica adecvată. Dacă nu sunteți încrezători, folosiți-vă de instrumente online pentru a verifica ortografia și gramatica înainte de publicare.
scrie pentru lume, nu pentru profesor
deși multe dintre eseurile tale se vor baza pe experiențele tale făcând sarcini la domiciliu (adică experiențe), nu scrie eseul tău ca și cum ar fi un e-mail privat către profesor explicând sarcina. Nu creați secțiuni pentru a răspunde la fiecare dintre „întrebările” din prompt. Dacă faceți asta, veți crea aproape sigur un eseu plictisitor care nu este interesant de citit.
în schimb, scrie-l „pentru lume”. Să presupunem că un profesionist tehnic aleatoriu a căutat pe Google și a apărut eseul tău. Faceți eseul autonom, auto-explicativ și util pentru acel profesionist aleatoriu. Minimizați ipotezele pe care le faceți despre fundalul ingineriei software a acelei persoane (cu atât mai puțin fundalul lor în această clasă!) Furnizați linkuri către materialul de fundal, dacă este util.
nu numai că ar trebui să-l scrie pentru o varietate de oameni, ar trebui să-l scrie pentru o varietate de ori. Cu alte cuvinte, încercați să vă scrieți eseul astfel încât, dacă cineva îl citește într-un an, acesta va oferi în continuare informații de valoare. Dacă sunteți un începător la subiect, atunci scrieți-l pentru a oferi înțelegere și înțelegere altor începători.
pentru a face un eseu convingător, este de obicei util să „spui o poveste”. Creați o narațiune, nu răspundeți doar la întrebări.
formatați codul în mod corespunzător
asigurați-vă că codul se afișează corect în postarea dvs. Realizați acest lucru utilizând blocuri de cod îngrădite și evidențierea sintaxei. Iată un exemplu de evidențiere a codului javascript :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}gândiți-vă cu atenție înainte de a include fragmente mari de cod (dincolo, să zicem 50 de linii). De regulă, păstrați fragmentele de cod la o lungime rezonabilă și asigurați-vă că tot codul este direct legat de subiectul eseului dvs.
folosiți titluri interne pentru a vă structura eseul
eseurile bune au un fel de structură internă. Ajutați cititorul să înțeleagă această structură prin furnizarea de titluri interne. Nu începeți cu H1 (adică # în Markdown), deoarece acesta este rezervat titlului postării dvs. În schimb, începeți cu H2 (## în markdown), apoi creați subsecțiuni în acea secțiune cu H3 (### în markdown) etc.
în mod similar, utilizați liste detaliate sau enumerate, tabele etc., după caz.
Format și atribut citate
veți dori ocazional să citeze un alt scriitor în eseuri tehnice. Acest lucru este bine atâta timp cât nu prezentați aceste cuvinte ca fiind ale voastre.
dacă citați doar o singură propoziție sau două, puteți folosi pur și simplu cursive, ghilimele și furnizați numele autorului. De exemplu:
după cum a remarcat Steve Jobs, „designul nu este doar ceea ce arată și se simte. Designul este modul în care funcționează.”
pentru ghilimele mai lungi, utilizați < blockquote>mediu împreună cu <subsol>. De exemplu:
un tânăr cinic este aproape cea mai tristă priveliște de văzut, pentru că înseamnă că el sau ea a trecut de la a nu ști nimic la a nu crede nimic.
includeți imagini sau alte medii
după cum se spune, „o imagine valorează cât o mie de cuvinte.”Este foarte ușor să includeți imagini și videoclipuri în eseurile dvs. Dacă semnificația eseului dvs. va fi comunicată mai clar cu imaginile, faceți timp pentru a le găsi și a le include. Consultați secțiunea Formatare din Ghidul de Utilizare TechFolio pentru instrucțiuni despre cum să includeți imagini și videoclipuri.
nu fi plictisitor, nu fi nepotrivit
doar pentru că eseul este de natură tehnică, nu trebuie să fie plictisitor. Încercați să vă injectați personalitatea în scrisul dvs. Puteți avea titluri „inteligente”, referințe la cultura pop și așa mai departe.
pe de altă parte, nu treceți peste bord cu inteligența. Întrebați-vă: aș fi jenat dacă mama mea ar citi acest eseu? (Pentru că s-ar putea.) Aș fi jenat dacă un potențial angajator ar citi acest eseu? (Pentru că s-ar putea.)
scopul este de a fi creativ, de a arăta o anumită personalitate și de a face eseul distractiv de citit, precum și informativ.
nu o scrie în ultimul moment
calitatea eseurilor tale va crește substanțial dacă le dezvolți după cum urmează:
- scrieți prima schiță.
- faceți altceva timp de 4 ore.
- reveniți și faceți o trecere de editare peste prima schiță.
trecerea de editare va prinde în mod normal o mulțime de probleme și vă va permite să vă rafinați gândurile în mod semnificativ, atâta timp cât v-ați îndepărtat de eseu pentru o perioadă suficientă de timp pentru a vă permite să o vedeți cu „ochi proaspeți”. Cel mai bun mod de a face acest lucru este să dormiți peste noapte, dar dacă nu aveți atât de mult timp, atunci cel puțin faceți ceva diferit pentru câteva ore. Acest lucru vă permite subconștientului să lucreze la material.
examinați conținutul și aspectul postării dvs.
după ce l-ați scris și publicat, recuperați-l într-un browser și vedeți cum arată.
un paragraf nu este suficient
scrierea unui eseu de două sau trei propoziții în speranța de a obține un credit parțial nu este o strategie bună. Pentru un singur lucru, un astfel de eseu reflectă mai slab pe persona dvs. profesionale decât nici un eseu, la toate. Pentru un alt lucru, avem tendința de a acorda zero puncte pentru eseuri care reflectă foarte puțin efort.
face uz de Uh Manoa Writing Center
Uhm Writing Center oferă consultanți care sunt instruiți pentru a ajuta la toate etapele procesului de scriere; dacă sunteți doar Noțiuni de bază, revizuirea un proiect, sau la un moment dat în între.
puteți programa până la două întâlniri pe săptămână, precum și trei întâlniri walk-in pe săptămână.