'technical writing'에 해당되는 글 1건

이제 막 블로그를 시작해보려고 하던 찰나에 회사에서 technical writing 에 대해서 설명해주는 기회가 있어서 듣게 되었다.

매주 한두시간씩 진행 할 예정이고 그때마다 정리해서 올려보려고 한다.

일단 Technical writing 의 개념부터 알아보기 전에 Technical communication 에 대해 알아보자.

위키에 잘 나와있지만 다 읽어보기 힘드니까 요약하자면

Technical communication is a method of researching and creating information about echnical process or products directed to audience through media. 

미디어를 통해 사람들한테 전달되는 technical process 나 제품에 대한 정보를 조사하고 생성하는 방법.

내가 이해한 느낌은 Technical communicator 가 각종 미디어를 통해 Tehchnical information 을 전달하는 것을 통 틀어서 Technical communication 이라고 이해했다.

기술문서 작성 이라고하면 당장 와닿지가 않는다.

카메라 메뉴얼, 세탁기 작동법 등등 넓은 범주가 있다. 

Technical communication 은 일방통행이지만 Technical writing 은 상호작용이 가능하다.

우리나라에서 Technical writing 이 중요해짐에 따라서 이제는 하나의 industry 로 분류되고 있다고 한다.

여기까지가 서두였고 이제 본론으로 들어가보자.

테크니컬 블로그 컨텐츠 작성 5개의 팁

Write it with a high-schooler in mind (고등학생을 염두에 두고 글을 작성해라)

1. 전문적인 영역, 긴글을 지양하고  단순,명료한 문장으로 글을 작성해라.
2. 글쓴이가 생각하는 독자와 실제 독자의 괴리가 있다.

내 블로그에 높은 수준의 전문적인 훌륭한 글( 물론 없지만 )을 어떤 엔지니어가 읽고 마지막 결재자에게 내 글을 전달하는데 문제가 있을 것이다. 그 결재자는 전문용어를 알아듣지 못할 것이기 때문이다.. 

그래서 고등학생에게 알려준다는 마인드로 글을 작성하라는 것이다.

Use analogies and examples ( 유추와 예제를 사용해라 )

1. 예를 들어라.
2. 유추법을 사용해라.

내가 쓰고 있는 주제와 독자가 연관될 수 있는 유사점을 만들어 내야 한다.

적절한 유추법의 사용은 읽는이가 사물을 바라보는 새로운 관점을 제시해 준다.

예를 드는 것은 지금 이 글에서도 몇몇 부분은 예를 들어서 설명한 부분이 있다.

Keep it simple and include links to more information

 ( 간결하게쓰며 자세한 사항은 링크를 사용한다. )

1. 블로그의 길이 조절하기
2. 링크를 사용해라

너무 길다면 흥미를 빨리 잃을것이다.

한번 앉아서 읽을 때 한번에 슉 읽어낼 수 있는 정도.

링크를 사용하면 기술적으로 보이고, 내 블로그에 들어오면 좋은 곳으로 연결된다는 이미지를 느껴지게 할 수 있다.

Format for easy reading  ( 읽기 쉬운 서식을 이용한다. )

1. 기술 블로그 일수록 요점이 한눈에 들어오도록 시작적으로 구조를 정해라.
2. 주제목과 부제목의 내용이 부합되게 정해라.
3. bullet 과 숫자는 각 주제를 부각시키고 순서를 분명히 해준다.
4. 여백을 이용하여 눈에 피로감을 덜고 중요한 부분을 부각시킨다.
5. 단락은 짧게해라.

Use expressive language ( 설명하듯이 쓴다. )

1. 소설을 쓰는 느낌으로 블로그 포스트를 써라
2. 기술 관련 블로그를 쓰면 다조로울 수 있지만 감정을 넣는다면 주의를 끌고 활기찬 글이 될 수 있다.
3. 감정이 들어간 말들을 적절히 사용하면 지루한 주제도 살릴 수 있다.