소프트웨어 개발자는 글을 잘 써야 한다.

Jun 29. 2021

퇴근 후 집 앞에 산에 다녀왔다. 아카시아 향이 온 산에 진동한다. 이런 아름다운 자연을 보면 마음의 치유를 얻는다. 이런 아름다운 자연을 보며 글로 표현 한다면 더욱더 좋을 것이다.

소프트웨어 개발자는 글을 잘 쓸 수 있어야 한다. 코딩만 잘한다고 해서 좋은 개발자가 아니다. 소프트웨어 개발 과정에서 커뮤니케이션은 대부분 글로 한다. 코딩만 잘하고 글을 잘 쓰지 못하는 개발자는 커뮤니케이션을 원활하지 못하게 되어 프로젝트에 방해가 된다.

개발자만 아는 단어로 문서를 만들어 다른 사람을 이해시키지 못하면 좋은 개발자가 아니다. 뛰어난 소프트웨어 개발자가 되기 위해서는 글 쓰는 연습을 꾸준히 해야 한다. 다른 사람이 쉽게 이해할 수 있는 글을 써야 한다. 글을 어렵게 쓴다는 것은 그 내용을 정확히 모른다는 것이다. 초등학생이 보더라도 이해하기 쉽게 써야 한다. 무엇보다도 실전에서 글 쓰는 습관을 들여 시나브로 생활하는 것이 중요하다.

누구나 하루에 몇 통씩의 이메일은 보낼 것이다. 첨부되는 문서나 메일 본문을 간결하고 쉽게 적어야 한다. 깔끔하게 적어야 한다. 파워포인트도 유튜브로 한 달만 공부하면 수준급의 문서를 만들 수 있다. 문서 하나로 이미 다른 사람과 차별화가 되는 것이다. 이것은 내가 직접 경험했다. 며칠 전 교회의 의사 선생님 중의 한분이 강의하는 것을 들었다. 코로나 팬데믹 시대의 코이노니아에 대한 내용인데 의미 있는 내용이고 다 좋았다. 그런데 파워포인트 강의 자료가 너무 성의가 없었다. 의대 교수님이라 바빠서 그랬는지 파워포인트 내용에 텍스트만 표시하고 정렬도 되지 않았다. 성의 없는 문서는 신뢰를 잃어버린다. 내용에 맞는 콘텐츠와 더불어서 문서에 정성을 들여서 작성해야 독자에게 신뢰를 줄 수 있다.

문서 작성할 때에 어느 단계에 올라가면 이미 만들어 놓은 Template를 가져다 쓰면 되기에 어느 수준에 올라가면 쉽다. 그 어느 단계에 올라가기까지 자기의 시간을 희생해서 공부해야 한다. 그러면 그다음은 너무 쉽다.

우리 모두는 작가다.

매일 어느 누군가에 메일이건 카톡을 하건 여러 독자에게 글을 쓴다. 독자들을 위해서 글을 잘 쓰고 문서를 잘 작성하려면 다음 사항을 고려하자.

읽는 독자의 눈높이에 맞춰 글을 적어야 한다.

문서를 어렵게 만든 사람은 근본이 악한 사람이라고 생각한다. 상대방에게 엿 먹으라는 것과 똑같다.

글은 초등학생이라도 알기 쉽게 작성하는 사람이 실력 있고 겸손한 사람이다. 자기만 아는 전문 분야의 내용을 어려운 글로 쓰면 어쩌자는 것인가? 이것은 테러다. 여러 계층의 사람들을 대상으로 한다면 특히 더 대중이 이해하기 쉽게 작성해야 한다.

두괄식으로 말하고 주제를 직접적으로 명시한다.

결론을 먼저 말하고 세부사항을 설명하는 것이 좋다. 가장 중요한 내용이 문장의 맨 처음에 오도록 두괄식으로 작성해야 한다. 요즘 사람들은 모두 바쁘다. 자세히 읽지 않는다. 먼저 결론을 맨 문장의 앞에 둬야 한다.

읽는 독자의 기대에 맞게 필요한 내용만을 적는다.

글을 쓸 때 상대방의 입장에서 생각해본다. 독자가 기대하는 정보는 만족할 만큼 충분히 기술하고 불필요한 내용은 쓰지 않는다. 아무리 좋은 내용이라 하더라도 주제와 관련이 없다면 글쓴이와 읽는 이의 시간을 낭비할 뿐이다.

사실과 의견을 확실히 구분해서 적는다.

먼저 사실을 확실하게 이야기해서 독자를 이해시켜야 한다. 개인의 의견인 경우 개인의 의견임을 확실히 밝힐 필요가 있다. 읽는 사람이 오해하지 않게 확실하게 선을 그어 사실과 의견을 구분해야 한다.

맞춤법에 맞게 작성한다.

올바른 맞춤법은 문서의 신뢰도를 높여준다. 카톡에서 오타가 난 글을 받으면 갑자기 상대방에 대해 한번 더 생각하게 된다. 진짜 오타인가? 아니면 노안이라서 잘못 입력한 것일까? 맞춤법을 진짜 모른 것인가?

오타는 독자로 하여금 쓸데없는 의문을 갖게 만든다. 맞춤법, 외래어 표기 등에 주의해 오류가 없도록 해야 한다. 부산대 맞춤법 검사기를 이용해도 좋다.

읽기 편하고 이해하기 쉽게 구성한다.

그림을 이용해서 설명하면 가장 좋다. 상대방을 이해시키려면 그림을 그려야 한다. 문서에 그림을 그려 설명하면 상대방이 이해하지 못해 여러 번 주고받는 이메일의 횟수를 줄일 수가 있다. 적당한 여백과 알맞은 폰트 등을 통해서 독자가 읽기 쉽게 만들어야 한다. 빽빽한 글자로 작성된 문서로 독자를 괴롭히면 안 된다.

글을 잘 쓰고 읽기 편하게 쓰는 사람은 인간미가 있는 사람이다. 상대방을 사랑하는 사람이다. 겸손한 사람이다.

문서 꾸미기에 시간을 할애해야 한다.

문서를 예쁘게 세련되게 디자인하는데 시간을 들이지 말라고들 이야기한다. 이것은 아니라고 생각한다.

보기 좋은 떡이 맛도 있다. 디자인이 세련된 문서는 신뢰감을 준다. 글 쓰는 이의 애쓰는 노력과 열정이 보인다. 내용을 정확하게 전달하는 것과 더불어서 문서를 아름답게 디자인해보자. 이것은 상대방을 위한 사랑 실천이다. 한번만 만들어 놓으면 계속 가져다 쓰면 되기에 나중에는 품격있는 문서를 금방 만들 수 있다.