엔지니어를 위한 글쓰기 (3) 썸네일형 리스트형 [글쓰기 코칭] #3 - 테크니컬 라이팅 : 논점이 명확한 메일 쓰기 어떤 직무이든, 직장에서는 이메일로 내용을 주고받는 일이 흔합니다. 협업의 중요성이 강조되면서 이메일, 사내 메신저를 더욱 적극적으로 사용하고 있는 추세로 이메일을 통해 의사소통의 목표를 달성하는 것은 과거보다 훨씬 더 중요해졌습니다. 협업의 요청, 상사의 설득, 정보의 공유 등 다양한 목적을 가지고 메일을 작성하지만 각기 다른 목적이더라도 기본적으로 메일은 '잘' 써야 하고 싶은 말을 효과적으로 전달하고 목표를 달성할 수 있습니다. '잘 쓴 메일'은 하고 싶은 말이 명확하게 보이는 메일입니다. 메일을 잘 쓰기 위해서는 분명하게 논점을 밝히고, 내용이 잘 구분되어 있으며, 문장은 짧고 간결해야 합니다. 반대로 잘 쓰지 못한 메일은 하고 싶은 말이 명확하지 않은 메일입니다. 논점이 불분명하며 내용이 섞여 .. [글쓰기 코칭] #2 - 테크니컬 라이팅 : 기술 문서 작성 시 지켜야 할 원칙 4가지 지난 Part에서는 테크니컬 라이팅의 개념과 글쓰기 작성 프로세스에 대해 알아보았습니다. 일반 글쓰기의 경우 형식과 표현의 제한 없이, 정해진 원칙이나 규칙과 상관없이 자유롭게 쓸 수 있지만 테크니컬 라이팅은 주의해야 할 몇 가지 원칙이 있습니다. 오늘은 테크니컬 라이팅의 네 가지 원칙에 대해 알아보겠습니다. 1. 정확성 정확한 글이란 독자가 필요로 하는 정보를 기술적 오류 없이 정확하게 제공하는 글을 말합니다. 비록 명확하지 않고 간결하지 않은 글이더라도 정확한 글이라면 독자들은 끝까지 해당 문서를 읽고 이해할 수 있습니다. 하지만 잘못된 정보를 포함한 기술 문서는 내용을 이해한다고 해도 결국 잘못된 정보를 제공했기 때문에 필요 없는 문서가 됩니다. 따라서 기술 문서를 작성할 때에는 특히 정확도에 주의.. [글쓰기 코칭] #0 - 테크니컬 라이팅 : 기술자가 글도 잘 쓸 필요가 있을까? 개발자는 개발을 잘하고 엔지니어는 엔지니어링만 잘하면 되는 것 아닌가요, 저 역시 그렇게 생각했습니다. 그런데 우리 OSC 안에서만 해도 글 쓰기를 고민하는 분들이 있었고 실제로 업무에서 메일이나 문서를 활용해 의사소통 하는 일이 많았습니다. IT 기술자도 글을 잘 쓸 수 있어야 합니다. 보다 올바르게 기술 문서, 장애 보고서, 개발 가이드, 요구 사항 정의서를 작성하고 일상의 업무 속에서도 본인의 의사를 명확하게 전달하고 효과적이고 효율적인 협업을 가능하게 하는 글을 작성해야만 합니다. 의사소통 오류의 예 ‘의사 소통의 오류’와 관련된 글을 찾아보면 위와 같은 그림을 쉽게 찾아볼 수 있습니다. 그림을 보면 고객이 설명한 것, PM이 이해한 것 그리고 각 작업자들의 작업물과 실제로 만들어진 것 그리고 사.. 이전 1 다음
