ez az osztály az Ön számára számos lehetőséget, hogy gyakorolják a művészet MŰSZAKI esszéírás. Íme néhány egyszerű útmutató, amellyel elkerülheti a gyakori problémákat.
nevezze el az esszé fájlt tárgya (nem dátuma) szerint.
a techfolio template essay fájlokat a létrehozásuk dátumával (azaz 2015-08-26.md). ne tegye ezt: nevezzen meg minden esszefájlt, hogy tükrözze annak tárgyát. Például a fájlnevet az esszé címére alapozhatja. Ha az esszé címe “a tűz meggyújtása”, akkor a fájl neve lehet “igniting-the-fire.md”.
ne tartalmazzon szóközöket a fájlnévben: használja “igniting-the-fire.md”, nem “meggyújtja a fire.md”.
ha a böngésző a megjelenítés helyett letölti a fájlt, az valószínűleg azért van, mert a fájlnév nem végződik “.md” – vel.
fontos a helyes elnevezés, hogy az esszéhez társított URL könnyen olvasható legyen, és jelezze annak tárgyát.
soha ne használja a “reflect” vagy a “reflections” kifejezést a fájlnév részeként.
hozzon létre egy érdekes címet, amely felhívja az olvasót.
ne nevezze el esszéjét a modul nevével (azaz “konfigurációkezelés”) vagy az élmény nevével (azaz “Reflections on Javascript”). A keresőmotorok gyakran hangsúlyozzák az oldalak címét. Szeretne olvasni egy esszét egy ilyen cím alapján? Biztos, hogy nem. egy kis gondolkodással előállhat valami személyes (azaz “a konfigurációkezelési katasztrófa, amely majdnem a munkámba került”) vagy okos (“nem mindig tudod git, amit akarsz”).
soha ne használja a “reflect” vagy a “reflections” címet a cím részeként.
használjon megfelelő helyesírást és nyelvtant
ne írjon el hibásan szavakat. Használjon megfelelő nyelvtant. Ha nem biztos benne, használja ki az online eszközöket a helyesírás és a nyelvtan ellenőrzéséhez a közzététel előtt.
írjon a világnak, ne a professzornak
bár sok esszéje az otthoni feladatok (azaz tapasztalatok) során szerzett tapasztalatain alapul, ne írja meg esszéjét úgy, mintha egy privát e-mail lenne a professzornak, amely elmagyarázza a feladatot. Ne hozzon létre szakaszokat az egyes “kérdések” megválaszolásához a promptból. Ha ezt megteszi, szinte biztosan létrehoz egy unalmas esszét, amelyet nem érdekes elolvasni.
ehelyett írja be “a világnak”. Tegyük fel, hogy egy véletlenszerű műszaki szakember guglizott, és az esszéd megjelent. Tegye az esszét önállóvá, magától értetődővé és hasznosnak a véletlenszerű szakember számára. Minimalizálja az adott személy szoftverfejlesztési hátterével kapcsolatos feltételezéseket (még kevésbé a hátterét ebben az osztályban!) Adjon meg linkeket a háttéranyaghoz, ha hasznos.
nem csak azt kell írni, hogy a különböző emberek, meg kell írni, hogy a különböző alkalommal. Más szavakkal, próbálja meg úgy írni esszéjét, hogy ha valaki egy év alatt elolvassa, akkor is értékes információkat nyújt. Ha újonc vagy a témában, akkor írd meg, hogy betekintést és megértést nyújtson más kezdőknek.
ahhoz, hogy egy esszé meggyőző legyen, általában hasznos “elmondani egy történetet”. Készítsen elbeszélést, ne csak válaszoljon a kérdésekre.
formázza a kódot megfelelően
győződjön meg arról, hogy a kód megfelelően jelenik meg a kiküldetésben. Ezt bekerített kódblokkok és szintaxis kiemelés segítségével érheti el. Íme egy példa a javascript kód kiemelésére :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}gondolja át alaposan, mielőtt nagy kódrészleteket tartalmazna (mondjuk 50 soron túl). Ökölszabályként tartsa a kódrészleteket ésszerű hosszúságban, és győződjön meg arról, hogy az összes kód közvetlenül kapcsolódik az esszé témájához.
használjon belső fejléceket az esszé felépítéséhez
a jó esszéknek valamilyen belső szerkezete van. Segítsen az olvasónak megérteni ezt a struktúrát belső fejlécek megadásával. Ne kezdje a H1-gyel (azaz # a Markdown-ban), mivel ez a bejegyzés címére van fenntartva. Ehelyett kezdje a H2 – vel (## a markdown-ban), majd hozzon létre alszakaszokat a H3-mal (### a markdown-ban) stb.
hasonlóképpen használjon tételes vagy felsorolt listákat,táblázatokat stb.
Format and attribútum idézetek
időnként érdemes idézni egy másik írót a műszaki esszéiben. Ez rendben van mindaddig, amíg ezeket a szavakat nem a sajátjaiként mutatják be.
ha csak egy vagy két mondatot idéz, egyszerűen használhat dőlt betűt, idézőjelet, és megadhatja a szerző nevét. Például:
ahogy Steve Jobs megjegyezte: “a Design nem csak az, aminek látszik és aminek érzi magát. A Design így működik.”
hosszabb idézetekhez használja a < blockquote>környezetet a <lábléc> mellett. Például:
egy cinikus fiatal szinte a legszomorúbb látvány, mert ez azt jelenti, hogy a semmiről nem tudott, hogy semmit sem hisz.
képeket vagy más adathordozókat tartalmaz
mint mondják, “egy kép többet ér ezer szónál.”Nagyon könnyű képeket és videókat belefoglalni az esszéidbe. Ha az esszé jelentését világosabban közlik a képekkel, szánjon időt arra, hogy megtalálja őket. A képek és videók beillesztésére vonatkozó utasításokat a Techfolio Felhasználói útmutató formázás szakaszában találja.
ne legyen unalmas, ne legyen helytelen
csak azért, mert az esszé technikai jellegű, nem kell unalmasnak lennie. Próbálja meg beadni személyiségét az írásába. Lehetnek “okos” címek, popkulturális hivatkozások stb.
másrészt ne menjen túlzásba az okossággal. Kérdezd meg magadtól: zavarban lennék, ha anyám elolvasná ezt az esszét? (Mert lehet.) Zavarban lennék, ha egy potenciális munkáltató elolvasná ezt az esszét? (Mert lehet.)
a cél az, hogy kreatív, hogy megmutassa néhány személyiség, és hogy az esszé szórakoztató olvasni, valamint informatív.
ne írja meg az utolsó pillanatban
esszéinek minősége jelentősen megnő, ha az alábbiak szerint fejleszti őket:
- írja be az első vázlatot.
- csinálj valami mást 4 órán keresztül.
- gyere vissza, és csinálj egy szerkesztési menetet az első vázlaton.
a szerkesztési pass általában elkapni egy csomó problémát, és lehetővé teszi, hogy finomítsa a gondolatait jelentősen, mindaddig, amíg kilépett az esszé elegendő ideig, hogy lehetővé teszi magát, hogy “friss szemmel”. A legjobb módszer erre az, ha egy éjszakán át alszol rajta, de ha nincs annyi időd, akkor legalább néhány órán keresztül csinálj valami mást. Ez lehetővé teszi, hogy a tudatalatti az anyagon dolgozzon.
tekintse át a bejegyzés tartalmát és megjelenését
miután megírta és közzétette, töltse le egy böngészőben, és nézze meg, hogyan néz ki.
egy bekezdés nem elég
két vagy három mondatos esszé írása a részleges hitel reményében nem jó stratégia. Egyrészt, egy ilyen esszé jobban tükrözi szakmai személyiségét, mint egyáltalán nincs esszé. Egy másik dolog, hajlamosak vagyunk nulla pontot adni olyan esszékért, amelyek nagyon kevés erőfeszítést tükröznek.
használja az UH Manoa Íróközpontot
az UHM Íróközpont olyan tanácsadókat kínál, akik képzettek arra, hogy segítsenek az írási folyamat minden szakaszában; akár csak most kezdődik, felülvizsgálja a tervezetet, akár valamikor a kettő között.
hetente legfeljebb két találkozót, valamint heti három bejárási találkozót ütemezhet.