개발자 글쓰기의 중요성

최근 나와 부장님을 동시에 이마를 짚게 하는 문제가 생겨서 포스팅해본다.

 

다른 회사와 나름 '협업'이라는 것을 하면서 메일이나 카톡을 주고 받는 일이 생기곤 한다.

 

이번 사건(?)은 외부 업체의 기가 막힌 글쓰기로 인해 비롯되었다.

 

발단

외부 업체에서 개발한 앱이 우리 회사에서 개발한 앱을 딥링크로 호출하는 상태이다.

(이제 외부 업체를 A사라고 칭하겠다)

 

아이디/ 비밀번호 찾기 버튼 클릭 시, A사에 API 요청을 통해 링크를 받아와 해당 링크를 웹뷰로 보여준다.

(여기서 이해가 되지 않는 부분은 이미 프로덕션 트랙으로 릴리즈가 되었는데

해당 링크가 유효하지 않아 웹뷰는 에러를 보여주고 있다.)

 

부장님과 A사의 카톡방에서 A사가 아이디/ 비밀번호 찾기 링크가 변경되었다고 공지했다.

 

그리고 A사가 보낸 메일에서 자사 앱의 딥링크가 변경되었다고 했다.

 

내가 해야할 행동은?

일단 부장님께 위 내용을 전해들었다.

 

여기서 내가 뭘 해야할까?

 

내가 추론한 내용은 이렇다.

 

API 호출 시 받아온 링크가 메일로 받았던 변경된 딥링크였다.

 

그럼 아이디/ 비밀번호 찾기 버튼 클릭 시 해당 딥링크로 앱을 호출하면 되는 것일까?

 

정답은 내가 추론한대로 였다.

 

내가 생각하는 글

물론 A사 인원과 직접 카톡이나 전화를 통해서 소통할 수 있는 상황이었다면 메일이 크게 중요치 않았을 수 있다.

 

하지만, 나를 포함해 직접 소통하신 부장님도 이해하지 못하는 글은 오전 내내 나를 헷갈리게 했다.

 

공식적인 채널을 통해 전달되는 글이 이렇게 맥락이 없어도 되는 것일까?
아무리 기존 독자와 상황을 공유했다지만 그 기존 독자조차 못 알아보는 글은 과연 제대로 쓴 글인가?

 

모든 사람이 알아볼만한 글은 쓸 수 없는 것이 당연하다.

 

그래도 어느 정도의 맥락은 있어야 내가 쓴 글의 독자를 이해시킬 수 있지 않을까?

 

이런 생각을 하게 된 이유

최근 동료에게 글쓰기에 관한 책을 하나 빌려서 읽고 있는데, 이 때문에 글(주로 메일)에 민감해진 것 같다.

 

다른 사람에게 엄격한 잣대를 들이미는 것은 좋지 않기 때문에 나도 글을 쓸 때 최대한 내 의도가 왜곡되지 않도록 노력하고 있다.

 

그래서, 최근 앱 업데이트를 위해 QA팀에 수정사항을 전달할 때에도 어떤 기능이 업데이트되었는 지,

시나리오 변경이 어떻게 이뤄졌는 지에 대해 오해의 소지가 없도록 노력했다.

 

또, 글쓰기에 대해 생각하다 보니 화법에도 다시금 관심이 생기고 있다.

 

화법은 다음에 천천히 읽을 책을 선정해두어야겠다.

 

이후에 지금 읽고 있는 글쓰기에 관한 책을 다 읽으면 정리해서 포스팅해볼 생각이다.