개요

본 포스팅은 Technical Writing 강의를 요약한 글입니다.
저자의 요청이 있을 시 삭제될 수 있으며, 다른 곳으로 퍼가는 것을 불허합니다.

글쓰기

글쓰는 이유 : 의사소통의 필수 불가결, 의사소통 방법중 가장 정확하고 보편화된 방법
디자인, 프로그래밍, 테스팅, 프로젝트 운영 프로세스는 모두 툴로 자동화 할 수 있지만, 문서 발행은 인간의 힘을 빌릴 수 밖에 없음
문학이 아닌 글쓰기는 요령(skill)이 필요하다.

비지니스 글쓰기

정의 : 커뮤니케이션을 통해 업무 효율성과 지식을 극대화 하는 글쓰기
대외적 글쓰기 : 공문서, 설명서..
내부용 글쓰기 : 기안서, 기획서..
사적인 글쓰기 : 자기소개서, 이력서
웹 글쓰기 : 이메일, 위키

기술 글쓰기 (Technical Writing)

정의 : 해당 분야의 복잡하고 어려운 기술적 내용을 이해하기 쉽게 기술
논문, 공문, 보고서, 자기소개서, 제품 설명서, 슬라이드

글쓰기의 기본 원칙

잘 못 쓴 글 : 초점이 흐리다. 읽을 수록 짜증난다. 성의가 없다.
연구수행 능력이 Technical Report 작성 능력과는 다르다
기획 능력이 기획서 작성 능력과는 다르다.
알아야 하는 것 : 아이디어(주제)찾기, 독자분석, 논리구조, 시각화, 글쓰기 과정, 문법규칙, 문장구성

독자 분석

글쓰기 목적 : 정보제공, 명령(지시), 설득(제안), 요청(부탁), 경고, 약속, 추천, 확인
독자를 분석하라
- 중요한 메시지를 전달하는데 있어 일관성이 흔들리지 않아야 한다.
- 아마추어는 자신이 하고 싶은 얘기를 적지만, 프로는 상대방이 알고 싶은 정보를 전한다.
- 남이 못알아 들으면, 상대방의 무식이 문제가 아니라 나의 전달능력 때문이다.
- 독자와 글쓴이와의 관계 및 독자가 가지고 있는 정보에 의해 글의 수준과 방향이 결정된다.
- 같은 깊이라도 독자에 따라 깊이를 조절하라.
독자분석 방법
- 어떤 직업, 어떤 직위인지 파악
- 독자의 학력과 전문용어 이해 수준 파악
- 필자와 독자의 관계
- 독자가 새로운 정보라고 느끼는가?
- 독자가 이미 알고 있는 사실은 무엇인가?
- 독자가 이해하는데 필요한 사전 정보는 무엇인가?
- 독자가 어떻게 피드백하기 바라는가?

글의 구성

구성 : 글의 설계도
- 필자가 생각을 배열한 순서가 독자의 사고 프로세스와 일치하지 않으면 이해하기 힘듬
- 글로 쓰기전에 사고 구조를 만드는 방법이 필요 : 마인드맵, 피라미드 구조
논리적이지 않은 글
- 비약이 심하다
- 누락이 있다
마인드 맵
- Data -> 정보추출 -> 구조화
- 자신이 알고 있는 범위에 대해 일관된 흐름으로 정리할 수 있다.
- 마인드맵으로 정리하고, 피라미드 구조로 점검한다.
- 참고 서적 : 생각정리의 기술
피라미드 구조
- 맥킨지의 바바라 민토에 의해 만들어짐
- 지적 프로세스는 Grouping과 요약의 사고 프로세스를 수반한다.
- 머리속 정보는 관련성을 가진 여러개의 피라미드로 구성된 복합체이다.
- 논리적으로 명확한 글은 항상 생각이 계층적으로 배열되어 피라미드 구조를 가지고 있다.
- 상위에 핵심적인 생각이 있고, 구체적이고 부서적인 생각의 그룹이 아래를 떠받침
- 피라미드 내부에서는 생각이 수평과 수직으로 연결됨
- 하부의 근거들은 중복,누락,착오 없이 수평적
- 하부의 근거들로 핵심을 추출한 것이 상위의 결론이 됨
- 상위의 결론이 되는 이유는 하부의 근거로 이루어짐

논리를 점검하는 원칙

세로의 법칙 : So what? (그래서 결론은? bottom-up) Why so? (왜 그런데? top-down)
가로의 법칙 : 어떤 사항과 개념이 서로 중복 없이, 전체적으로 누락 없어야 한다.
셀프 체크 방법
- Why so?에 충분히 대답하고 있는가?
- 핵심 메시지는 명확한가?
- 비지니스 문서(독자가 주제를 설정하고 대답을 기다리는 경우)는 결론을 먼저 전달하는 것이 적합하다. (Why so? 방식)
- 독자가 반발이 예상되거나 이해시켜야 하는 경우는 근거를 먼저 제시 (So what? 방식)

문장력

정의 : 독자에게 명확히 주제를 전달할 수 있게끔 문장을 구성하는 능력
좋은 글을 많이 읽고, 자주 써보면서 평가받는 것이 중요하다.
잘못된 호응 X : 목표는 실적을 올리려고 한다 --> 목표는 실적을 올리는 것이다.
조사의 오용 X : 휴가가 끝나고 --> 휴가를 끝내고
지나친 생략 X
중복 X : 똑같은 동질성 -> 동질성
대등성에 주의
접속어는 논리적으로 : 그러나(대립 접속) vs 그런데(전환접속)
접속사 원칙 : 최소한의 접속어만 쓴다. 생략하면 이상한 곳만 쓴다.
명사를 지나치게 나열 X
단어를 늘여 쓰지 않는다 : 만일 ~의 경우에 --> 만약
수식어는 수식되는 말 가까이 쓴다 : (아름다운 공주)의 드레스, 아름다운 (공주의 드레스)
주어와 서술어는 너무 멀지 않게 : 북측이 전쟁이 ~~ --> 전쟁이~~ 북측은~~
표현은 다양하게 : ~ 말했다. ~ 말했다 --> ~ 말했다. ~ 밝혔다.
명칭은 일관되게 : 데이타베이스, Database, DB --> 데이터베이스(이하 DB)
능동태를 사용 : 연료비 절감은 절연체 설치에 의하여 실현된다 --> 절연체를 설치하면 연료비를 줄인다.
수의 표현에 주의 : 과반수 이상이 찬성함으로써 --> 과반수가 찬성함으로써
'의'는 최소한 : 설립의 조건의 첫째는 --> 설립 조건의 첫째는
구어체 X : 안 늦추고 --> 늦추지 않고
'~적', '~성', '~화'를 남용 X : 복잡화되고 있다 --> 복잡해지고 있다.
번역투를 지양 : 한국어는 과거형,현재형,미래형만 있다
- 진행형 : 모색하고 있는 중이다 -> 모색하고 있다.
- 과거완료형 : 왔었던 적이 있다 -> 왔었다.
구체적으로 쓴다.
- 많은 참가자 --> 300여명의 참가자
- 고성능 --> 효율 95%
- 가까운 장래에 --> 오는 2014년 8월에
완곡법보다 단정법으로 : 자신감 있게
- ~ 하여야 한다고 생각한다 --> ~하여야 한다.
- ~ 라고 말할 수 있다 --> ~라 하겠다.
정확한 단어 : 축구를 찬다 --> 공을 찬다
복수 사용에 주의 : 국민들의 의식이 --> 국민의 의식이

문법 규칙

글의 완전성, 필자에 대한 신뢰감에 영향을 줌
띄어쓰기
- 모든 단어는 띄어쓴다.
- 전문용어는 단어별로 띄어 쓰지만, 붙여 쓸 수 있다 : 문서 관리 시스템 --> 문서관리 시스템
- 단음절이 연이어 나타나면 붙여 쓸 수 있다 : 한잔 술
- 조사나 어미는 붙여 쓴다 : 공부해야 겠다 -> 공부해야겠다
문장부호
- 글이 전체적으로 안정성을 갖게 해줌
- 쉼표 : 의미를 구분할때 사용. 위치에 따라 의미가 달라질 수 있으므로 유의
- 큰 따옴표 : 인용
- 작은 따옴표 : 강조
- 괄호 : 설명
외례어 : 컨텐츠 --> 콘텐츠, 캐쉬 --> 캐시
참고 : 국립국어원 - http://www.korean.go.kr

시각자료

표 : 제한된 공간에 방대한 양의 데이터 제시
그래프 : 경향성, 동향, 분포, 대조, 주기를 보기 쉽게 드러냄
- 막대형 : 상대적 크기를 비교
- 꺽은선형 : 추이
- 방사형 : 균형
- 파이형 : 비율을 볼때, 시계 방향으로 크기가 작아져야 함.
- 분산형 : 기대패턴 vs 실제패턴
그림
사진
흐름도 : 순서에 따라 보여주는 도식
조직도 : 구성요소의 연관 관계
주의사항
- 그림과 표가 하나 이상 사용시 번호를 달아라
- 보호된 자료는 허가를 받을것
- 공개된 자료도 제공자 정보를 삽입할 것