기술 에세이 스타일 가이드

이 클래스는 기술 에세이 작문의 예술을 연습 할 수있는 많은 기회를 제공합니다. 다음은 일반적인 문제를 피하기 위해 사용할 수 있는 몇 가지 간단한 지침입니다.

주제(날짜가 아님)에 따라 에세이 파일의 이름을 지정하십시오.

테크 폴리오 템플릿 에세이 파일은 생성 된 날짜(예:2015-08-26.md).이것을하지 마십시오:주제를 반영하기 위해 각 에세이 파일의 이름을 지정하십시오. 예를 들어,당신은 당신의 에세이의 제목에 파일 이름을 기반으로 할 수 있습니다. 에세이 제목이”불을 점화”하는 경우 파일 이름이”igniting-the-fire.md”.

파일 이름에 공백을 포함하지 마십시오.igniting-the-fire.md”,하지”점화 fire.md”.

브라우저가 파일을 표시하는 대신 파일을 다운로드하는 경우 파일 이름이”.“로 끝나지 않기 때문일 수 있습니다.

파일 이름의 일부로”반사”또는”반사”를 사용하지 마십시오.

독자에 그리는 흥미로운 제목을 만듭니다.

모듈 이름(예:”구성 관리”)또는 경험 이름(예:”자바 스크립트에 대한 반성”)으로 에세이의 이름을 지정하지 마십시오. 검색 엔진은 종종 페이지 제목을 강조합니다. 그런 제목에 따라 에세이를 읽고 싶습니까? 약간의 생각으로,당신은 개인적인 것(즉,”내 일에 거의 비용이 드는 구성 관리 재앙”)또는 영리한 것(“당신은 항상 당신이 원하는 것을 망할 수 없습니다”)을 생각해 낼 수 있습니다.

제목의 일부로”반사”또는”반사”를 사용하지 마십시오.

적절한 맞춤법 및 문법 사용

단어의 철자를 잘못 입력하지 마십시오. 적절한 문법을 사용하십시오. 너가 자부하지 않으면,간행물보다 전에 철자법과 문법을 검사하기 위하여 온라인 공구의 쓸모가 있으십시요.

교수가 아닌 세계를 위해 쓰기

당신의 에세이의 대부분은 가정 과제를 수행 한 경험(즉,경험)을 기반으로하지만,과제를 설명하는 교수에게 개인 이메일이라면 에세이를 쓰지 마십시오. 프롬프트에서 각”질문”에 대답 할 섹션을 만들지 마십시오. 당신이 그렇게 할 경우,당신은 거의 확실하게 읽을 재미없는 지루한 에세이를 만들 수 있습니다.

대신,”세계를 위해”쓰기. 어떤 임의의 기술 전문가가 인터넷 검색을했다고 가정하고 에세이가 나왔습니다. 에세이 자체 포함,자기 설명,그 임의의 전문가에게 유용합니다. 그 사람의 소프트웨어 엔지니어링 배경에 대해 가정하는 것을 최소화하십시오(이 수업에서의 배경은 훨씬 적습니다!)유용한 경우 배경 자료에 대한 링크를 제공하십시오.

당신은 다양한 사람들을 위해 그것을 작성해야 할뿐만 아니라,당신은 다양한 시간을 위해 그것을 작성해야합니다. 즉,누군가가 1 년 안에 그것을 읽으면 여전히 가치있는 정보를 제공 할 수 있도록 에세이를 작성하려고합니다. 너가 주제에 신참 이으면,그때 다른 초보자에게 통찰력과 이해를 제공하기 위하여 그것을 쓰십시요.

에세이를 설득력있게 만들려면 일반적으로”이야기를 전하는”것이 도움이됩니다. 내러티브를 만들고 질문에 대답하지 마십시오.

코드 형식을 적절하게

코드가 게시에 제대로 표시되는지 확인합니다. 차단된 코드 블록 및 구문 강조를 사용하여 이 작업을 수행할 수 있습니다. 다음은 자바 스크립트 코드 강조 표시의 예입니다:

function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}

큰 코드 스 니펫을 포함하기 전에 신중하게 생각하십시오(50 줄 이상). 어림셈으로,적당한 길이에 부호 단편을 지키고 부호의 모두가 너의 수필의 주제에 직접적으로 관련시킨다 것 을 확인하십시요.

내부 제목을 사용하여 에세이 구조화

좋은 에세이는 일종의 내부 구조를 가지고 있습니다. 독자가 내부 표제를 제공해서 이 구조를 이해할것을 돕십시요. 게시물의 제목을 위해 예약되어 있으므로 마크다운에서#로 시작하지 마십시오. 대신,시간 2(##에서 마크 다운)로 시작한 다음 시간 3(###에서 마크 다운)등으로 해당 섹션 내에 하위 섹션을 만듭니다.

마찬가지로 항목 별 또는 열거 된 목록,테이블 등을 적절하게 사용하십시오.

형식 및 속성 인용

때때로 기술 에세이에서 다른 작가를 인용하고 싶을 것입니다. 너가 너의 자신으로 그 낱말을 선물하지 않을 한 이것은 잘 이다.

한 문장 또는 두 문장을 인용하는 경우 기울임 꼴,인용 부호를 사용하고 저자 이름을 제공하면됩니다. 예를 들면:

스티브 잡스가 지적한 바와 같이,”디자인은 단지 모양과 느낌이 아닙니다. 디자인은 그것이 작동하는 방법이다.”

긴 따옴표의 경우<인용구>환경과<바닥글>을 사용합니다. 예를 들면:

냉소적 인 젊은이는 거의 볼 수있는 가장 슬픈 광경입니다.

그림 또는 기타 미디어를 포함

그들이 말하는 것처럼,”그림은 천 단어의 가치가있다.”에세이에 사진과 비디오를 포함시키는 것은 매우 쉽습니다. 에세이의 의미가 이미지와 더 명확하게 전달 될 경우 시간을 들여 찾아 포함 시키십시오. 이미지 및 비디오를 포함하는 방법에 대한 지침은 테크폴리오 사용 설명서의 서식 섹션을 참조하십시오.

지루하지 말고 부적절하지 마십시오

에세이는 본질적으로 기술적이기 때문에 지루할 필요는 없습니다. 너의 쓰기로 너의 개성을 주사한것을 해보십시요. “영리한”제목,대중 문화 참조 등을 가질 수 있습니다.

반면에,영리함에 배 밖으로 가지 마십시오. 자신에게 물어:내 어머니가 에세이를 읽을 경우 나는 당황 할 것? (그럴 수도 있기 때문이다. 잠재적 인 고용주가이 에세이를 읽으면 나는 당황 할 것인가? (그럴 수도 있기 때문이다.

목표는 창의적이고,개성을 보여주고,에세이를 재미있게 읽고 유익하게 만드는 것입니다.

마지막 순간에 작성하지 마십시오

다음과 같이 개발하면 에세이의 품질이 크게 상승 할 것이다:

  1. 첫 번째 초안을 작성하십시오.
  2. 4 시간 동안 다른 작업을 수행하십시오.
  3. 다시 와서 첫 번째 초안을 통해 편집 통과를 수행합니다.

편집 패스는 일반적으로 많은 문제를 포착하고 자신이”신선한 눈”으로 그것을 볼 수 있도록 충분한 시간 동안 에세이에서 물러난 한,크게 생각을 구체화 할 수 있습니다. 그것을 하는 제일 방법은 그것에 밤새껏 자는 이다,그러나 너는 저 다량 시간이 있지 않으면,그때 적어도 약간 시간을 위해 다른 무언가를 하십시요. 이것은 너의 잠재 의식을 물자에 일하기 위하여 가는 시킨다.

게시물의 내용 및 모양을 검토

게시하고 나면 브라우저에서 검색하여 어떻게 보이는지 확인합니다.

한 단락으로 충분하지 않다

부분적 신용을 얻기 위해 두세 문장 에세이를 쓰는 것은 좋은 전략이 아닙니다. 한 가지 들어,이러한 에세이는 전혀 에세이보다 전문 인물에 더 가난하게 반영. 또 다른 것은,우리는 약간의 노력을 반영하는 에세이에 대해 0 점을 수여하는 경향이 있습니다.

어 마노아 쓰기 센터의 활용

엄 쓰기 센터는 작문 과정의 모든 단계에서 도움을 훈련 컨설턴트를 제공합니다;당신은 단지 시작 여부,초안을 수정,또는 그 사이의 어떤 시점에서.

주당 최대 2 회의 약속과 주당 3 회의 워크인 약속을 예약할 수 있습니다.

답글 남기기

이메일 주소는 공개되지 않습니다.