ta klasa zapewni Ci wiele możliwości praktykowania sztuki pisania esejów technicznych. Oto kilka prostych wskazówek, których możesz użyć, aby uniknąć typowych problemów.
Nazwij plik eseju według jego przedmiotu (Nie daty).
pliki szablonu techfolio są nazwane datą ich utworzenia (tj. 2015-08-26.md). nie rób tego: nazwij każdy plik eseju, aby odzwierciedlić jego przedmiot. Na przykład możesz oprzeć nazwę pliku na tytule eseju. Jeśli tytuł eseju to „zapalanie ognia”, to nazwa pliku może być „igniting-the-fire.md”.
nie zawierają spacji w nazwie pliku: użyj „igniting-the-fire.md”, a nie „rozpalanie fire.md”.
jeśli przeglądarka pobiera plik zamiast go wyświetlać, prawdopodobnie dlatego, że nazwa pliku nie kończy się na”. md”.
prawidłowe nazewnictwo jest ważne, aby adres URL powiązany z Twoim esejem był łatwy do odczytania i zawierał wskazanie jego przedmiotu.
nigdy nie używaj „reflect” lub „reflections” jako części nazwy pliku.
Stwórz ciekawy tytuł, który przyciągnie czytelnika.
nie nazywaj swojego eseju nazwą modułu (np. „zarządzanie konfiguracją”) ani nazwą doświadczenia (np. „refleksje na temat Javascript”). Wyszukiwarki często podkreślają tytuł stron. Chciałbyś przeczytać esej oparty na takim tytule? Na pewno nie. z odrobiną myśli, można wymyślić coś osobistego (tj. „katastrofa zarządzania konfiguracją, która prawie kosztowała mnie moją pracę”) lub sprytnego („nie zawsze możesz git to, co chcesz”).
nigdy nie używaj „reflect” lub „reflections” jako części swojego tytułu.
używaj odpowiedniej pisowni i gramatyki
nie literuj źle słów. Użyj odpowiedniej gramatyki. Jeśli nie jesteś pewien, skorzystaj z narzędzi online, aby sprawdzić pisownię i gramatykę przed publikacją.
Pisz dla świata, nie dla profesora
chociaż wiele twoich esejów będzie opartych na twoich doświadczeniach podczas wykonywania zadań domowych (tj. doświadczeń), nie pisz swojego eseju, jak gdyby był to prywatny e-mail do profesora wyjaśniający zadanie. Nie twórz sekcji, aby odpowiedzieć na każde z „pytań” z monitu. Jeśli to zrobisz, prawie na pewno stworzysz nudny esej, który nie jest interesujący do czytania.
zamiast tego napisz „dla świata”. Załóżmy, że jakiś przypadkowy specjalista techniczny wygooglował i pojawił się twój esej. Spraw, aby esej był samodzielny, zrozumiały i przydatny dla tego przypadkowego profesjonalisty. Zminimalizuj założenia, które podejmiesz o Inżynieria oprogramowania tej osoby (a tym bardziej o jej tle w tej klasie!) Podaj linki do materiałów źródłowych, jeśli są przydatne.
nie tylko powinieneś pisać to dla różnych osób, powinieneś pisać to dla różnych razy. Innymi słowy, spróbuj napisać swój esej tak, że jeśli ktoś przeczyta go w ciągu roku, nadal będzie dostarczać informacji o wartości. Jeśli jesteś nowicjuszem w tym temacie, napisz go, aby zapewnić wgląd i zrozumienie innym nowicjuszom.
aby esej był atrakcyjny, Zwykle pomocne jest „opowiedzenie historii”. Stwórz narrację, nie odpowiadaj tylko na pytania.
odpowiednio sformatuj kod
upewnij się, że kod wyświetla się poprawnie w Twoim poście. Można to osiągnąć za pomocą ogrodzonych bloków kodu i podświetlania składni. Oto przykład podświetlania kodu javascript:
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}zastanów się, zanim włączysz duże fragmenty kodu (poza, powiedzmy 50 linii). Z reguły zachowaj fragmenty kodu na rozsądną długość i upewnij się, że cały kod jest bezpośrednio związany z tematem eseju.
użyj wewnętrznych nagłówków, aby uporządkować swój esej
dobre eseje mają jakąś wewnętrzną strukturę. Pomóż czytelnikowi zrozumieć tę strukturę, udostępniając wewnętrzne nagłówki. # w Markdown), ponieważ jest to Zarezerwowane dla tytułu Twojego postu. Zamiast tego zacznij od H2 (## w markdown), a następnie utwórz podrozdziały w tej sekcji za pomocą H3 (### w markdown) itd.
podobnie, użyj wyszczególnionych lub wyliczonych list, tabel itp.
formatowanie i cytowanie atrybutów
od czasu do czasu będziesz chciał cytować innego pisarza w swoich esejach technicznych. To jest w porządku, dopóki nie przedstawisz tych słów jako swoich własnych.
jeśli cytujesz tylko jedno lub dwa zdanie, możesz po prostu użyć kursywy, cudzysłowu i podać nazwisko autora. Na przykład:
jak zauważył Steve Jobs, ” Design to nie tylko to, jak wygląda i jak się czuje. Design jest jak to działa.”
aby uzyskać dłuższe cytaty, Użyj środowiska <blockquote> wraz ze stopką <>. Na przykład:
cyniczny młody człowiek jest prawie najsmutniejszym widokiem, ponieważ oznacza to, że przeszedł od niczego nie wiedząc do niczego nie wierząc.
Dołącz zdjęcia lub inne media
jak mówią, ” obraz jest wart tysiąca słów.”Bardzo łatwo jest dołączyć zdjęcia i filmy do swoich esejów. Jeśli Znaczenie twojego eseju zostanie przekazane wyraźniej za pomocą obrazów, poświęć trochę czasu, aby je znaleźć i uwzględnić. Zobacz sekcję formatowanie w Podręczniku użytkownika TechFolio, aby uzyskać instrukcje dotyczące dołączania obrazów i filmów.
nie bądź nudny, nie bądź nieodpowiedni
tylko dlatego, że esej ma charakter techniczny, nie musi być nudny. Spróbuj wprowadzić swoją osobowość do pisania. Możesz mieć „sprytne” tytuły, odniesienia do popkultury i tak dalej.
z drugiej strony nie przesadzaj ze sprytem. Zadaj sobie pytanie: czy byłbym zażenowany, gdyby moja matka przeczytała ten esej? (Bo może.) Czy wstydziłbym się, gdyby potencjalny pracodawca przeczytał ten esej? (Bo może.)
celem jest bycie kreatywnym, pokazanie pewnej osobowości i uczynienie eseju zabawnym do czytania, a także pouczającym.
nie pisz tego w ostatniej chwili
jakość Twoich esejów znacznie wzrośnie, jeśli opracujesz je w następujący sposób:
- napisz pierwszy szkic.
- zrób coś innego przez 4 godziny.
- wróć i wykonaj edycję pierwszego szkicu.
przepustka do edycji Zwykle łapie wiele problemów i pozwala znacznie udoskonalić swoje myśli, o ile odsunąłeś się od eseju na wystarczającą ilość czasu, aby pozwolić sobie na zobaczenie go „świeżymi oczami”. Najlepszym sposobem, aby to zrobić, jest spać na nim przez noc, ale jeśli nie masz tyle czasu, to przynajmniej zrób coś innego przez kilka godzin. To pozwala twojej podświadomości pracować nad materiałem.
przejrzyj zawartość i wygląd swojego posta
po napisaniu i opublikowaniu go, pobierz go w przeglądarce i zobacz, jak wygląda.
jeden akapit to za mało
pisanie dwu-lub trzy-zdaniowego eseju w nadziei na uzyskanie częściowego kredytu nie jest dobrą strategią. Po pierwsze, taki esej odbija się gorzej na twojej profesjonalnej osobowości niż żaden esej w ogóle. Z drugiej strony, mamy tendencję do przyznawania zero punktów za eseje, które odzwierciedlają bardzo mało wysiłku.
skorzystaj z Centrum pisania Uh Manoa
centrum pisania UHM zapewnia konsultantów, którzy są przeszkoleni, aby pomóc na wszystkich etapach procesu pisania; niezależnie od tego, czy dopiero zaczynasz, przeglądasz szkic, czy w pewnym momencie pomiędzy.
możesz zaplanować maksymalnie dwa spotkania tygodniowo, a także trzy spotkania w tygodniu.