안녕하세요, 산아입니다.

개발이나 기술능력만큼 중요한 것은 ‘커뮤니케이션’이라고 생각하는데요, 모든 고객(혹은 업무 관계자들)과 직접 대면을 통해 업무나 제품에 대한 설명을 한다는 것은 불가능에 가깝습니다.

이런 부분을 해결할 수 있는 방법은 바로 ‘문서화’인데요, 이 문서화를 통해 자기가 원하는 것을 효과적으로, 정확히 전달할 수 있는 기술이 바로 ‘테크니컬 라이팅(Technical Writing)’입니다.

이번에 좋은 기회가 생기게 되어 테크니컬 라이팅 서적을 읽어보고 이에 대해 요약 정리를 해보았습니다.

 

테크니컬 라이팅 핵심 요약.

1.     명쾌하게 (Clear)

-       수치, 단위, 기호 등이 정확하게 기술되어야 한다.

-       내용 표현이 정확해야 한다.

-       누락된 정보가 없어야 한다.

2.     간결하게 (Concise)

-       문장 이외의 타이포그라피, 레이아웃, 도해화 등으로 정보를 잘 표현해야 한다.
(읽혀지는 것보다 보여지는 것이 우선이다.)

-       문장의 길이가 너무 길지 않아야 한다.

3.     효율적으로 (Effectively)

-       내용이 잘 정리되어있어야 한다.

-       필요한 내용을 찾아보기 쉬워야 한다.

-       중복된 내용이나 군더더기문장이 없어야 한다.

이 게시물을...




profile

Happy SQLER~!

NEXON NDOORS DBA. 

SQLER.com Sysop / SQLTAG Vice-master / Microsoft SQL Server Frontier Group.

E-Mail: alucard@naver.com / Mobile: +82 10-5665-8554

http://www.sqler.com / http://www.sqltag.org / http://alucardkang.tistory.com