tato třída vám poskytne mnoho příležitostí k procvičování umění psaní technické eseje. Zde je několik jednoduchých pokynů, které můžete použít, abyste se vyhnuli běžným problémům.
pojmenujte soubor eseje podle jeho předmětu(nikoli podle data).
soubory eseje šablony techfolio jsou pojmenovány s datem, kdy byly vytvořeny (tj. 2015-08-26.md). nedělejte to: pojmenujte každý soubor eseje tak, aby odrážel jeho předmět. Název souboru můžete například založit na názvu vaší eseje. Pokud je název vaší eseje „zapálení ohně“ , pak může být název vašeho souboru „igniting-the-fire.md“.
nezahrnujte mezery v názvu souboru: use „igniting-the-fire.md“, ne „zapálení fire.md“.
pokud prohlížeč Stahuje soubor místo jeho zobrazení, je to pravděpodobně proto, že název souboru nekončí“. md“.
správné pojmenování je důležité, aby Adresa URL spojená s vaší esejí byla snadno čitelná a poskytla údaj o jejím předmětu.
nikdy nepoužívejte „reflect“ nebo „reflections“ jako součást názvu souboru.
Vytvořte zajímavý titul, který vtáhne čtenáře.
nepojmenujte svou esej názvem modulu (tj. „Správa konfigurace“) nebo názvem zkušenosti (tj. „úvahy o JavaScriptu“). Vyhledávače často zdůrazňují název stránek. Chtěli byste si přečíst esej na základě takového názvu? Určitě ne. s trochou přemýšlení můžete přijít s něčím osobním (tj. „katastrofa správy konfigurace, která mě téměř stála práci“) nebo chytrým („nemůžete vždy git, co chcete“).
nikdy nepoužívejte „reflect“ nebo „reflections“ jako součást svého titulu.
použijte vhodný pravopis a gramatiku
nepoužívejte překlep slova. Použijte vhodnou gramatiku. Pokud si nejste jisti, využijte online nástrojů ke kontrole pravopisu a gramatiky před zveřejněním.
pište pro svět, ne pro profesora
ačkoli mnoho vašich esejí bude založeno na vašich zkušenostech s domácími úkoly (tj. Nevytvářejte sekce pro zodpovězení každé z“ otázek “ z výzvy. Pokud to uděláte, téměř jistě vytvoříte nudnou esej, která není zajímavá ke čtení.
místo toho napište „pro svět“. Předpokládejme, že nějaký náhodný technický profesionál googlil a vaše esej přišla. Udělejte esej soběstačnou, samozřejmý, a užitečné pro toho náhodného profesionála. Minimalizujte předpoklady, které učiníte o pozadí softwarového inženýrství této osoby (mnohem méně jejich pozadí v této třídě!) Poskytnout odkazy na podkladový materiál, pokud je to užitečné.
nejen, že byste to měli napsat pro různé lidi, měli byste to napsat pro různé časy. Jinými slovy, zkuste napsat svou esej tak, že pokud ji někdo přečte za rok, bude stále poskytovat cenné informace. Pokud jste nováček na toto téma, pak napsat poskytnout vhled a porozumění ostatním nováčkům.
aby byla esej přesvědčivá, je obvykle užitečné „vyprávět příběh“. Vytvořte příběh, neodpovídejte jen na otázky.
formátujte kód vhodně
ujistěte se, že se kód ve vašem příspěvku správně zobrazuje. Toho dosáhnete pomocí oplocených bloků kódu a zvýraznění syntaxe. Zde je příklad zvýraznění kódu javascript:
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}před zahrnutím velkých úryvků kódu pečlivě promyslete (mimo, řekněme 50 řádků). Zpravidla udržujte úryvky kódu v přiměřené délce a ujistěte se, že celý kód přímo souvisí s předmětem vaší eseje.
použijte interní nadpisy pro strukturování vaší eseje
dobré eseje mají nějakou vnitřní strukturu. Pomozte čtenáři pochopit tuto strukturu poskytnutím Interních nadpisů. # v Markdown), protože je vyhrazeno pro název vašeho příspěvku. Místo toho začněte s H2 (## v markdown), pak vytvořte podsekce v této sekci s H3 (### v markdown) atd.
podobně použijte rozpis nebo vyjmenované seznamy, tabulky atd.
citace formátu a atributů
občas budete chtít citovat jiného spisovatele ve svých technických esejích. To je v pořádku, pokud tato slova nepředstavujete jako svá vlastní.
pokud citujete pouze jednu nebo dvě věty, můžete jednoduše použít kurzívu, uvozovky a uvést jméno autora. Například:
jak poznamenal Steve Jobs, “ Design není jen to, jak vypadá a vypadá. Design je, jak to funguje.“
pro delší uvozovky použijte prostředí <blockquote> spolu s <zápatí>. Například:
cynický mladý člověk je téměř nejsmutnější pohled vidět, protože to znamená, že on nebo ona přešla od nic neví věřit nic.
zahrnout obrázky nebo jiná média
jak se říká, “ obrázek má hodnotu tisíce slov.“Je velmi snadné zahrnout obrázky a videa do svých esejů. Pokud bude význam vaší eseje jasněji sdělen s obrázky, udělejte si čas na jejich nalezení a zahrnutí. Pokyny, jak zahrnout obrázky a video, naleznete v části formátování uživatelské příručky TechFolio.
nebuďte nudní, nebuďte nevhodní
jen proto, že esej má technickou povahu, nemusí být nudná. Pokuste se vložit svou osobnost do svého psaní. Můžete mít“ chytré “ tituly, odkazy na popkulturu atd.
na druhou stranu, nechoďte přes palubu na chytrosti. Zeptejte se sami sebe: byl bych v rozpacích, kdyby moje matka četla tuto esej? (Protože by mohla.) Byl bych v rozpacích, kdyby si potenciální zaměstnavatel přečetl tuto esej? (Protože by mohla.)
cílem je být kreativní, ukázat nějakou osobnost a učinit esej zábavnou pro čtení i informativní.
nepište to na poslední chvíli
kvalita vašich esejů se podstatně zvýší, pokud je vyvinete následovně:
- napište první koncept.
- udělejte něco jiného po dobu 4 hodin.
- vraťte se a proveďte editační průchod přes první koncept.
editační průchod obvykle zachytí spoustu problémů a umožní vám výrazně vylepšit vaše myšlenky, pokud jste od eseje ustoupili po dostatečnou dobu, abyste si ji mohli prohlédnout „čerstvýma očima“. Nejlepší způsob, jak toho dosáhnout, je spát na něm přes noc, ale pokud nemáte tolik času, udělejte alespoň několik hodin něco jiného. To umožňuje vašemu podvědomí pracovat na materiálu.
zkontrolujte obsah a vzhled vašeho příspěvku
jakmile jej napíšete a zveřejníte, načtěte jej v prohlížeči a podívejte se, jak vypadá.
jeden odstavec nestačí
psaní eseje o dvou nebo třech větách v naději, že získáte nějaký částečný kredit, není dobrá strategie. Pro jednu věc, taková esej odráží více špatně na své profesionální persona než žádná esej vůbec. Pro další věc, máme tendenci udělovat nulové body za eseje, které odrážejí velmi malé úsilí.
využijte Uh Manoa Writing Center
Uhm Writing Center poskytuje konzultanty, kteří jsou vyškoleni, aby pomohli ve všech fázích procesu psaní; ať už právě začínáte, revidujete návrh nebo v určitém okamžiku mezi tím.
můžete naplánovat až dvě schůzky týdně, stejně jako tři schůzky týdně.