구름 데브렐 매니저 ❄️Snow입니다. 이 글은 글쓰기에 익숙치 않은 개발자들을 돕기 위해 작성한 글쓰기 가이드입니다. 잡지사, 출판사, 마케터 등을 거치며 글을 ‘업’으로 삼으며 배우고 느꼈던 것을 틈틈이 정리한 글입니다. 빠진 내용도, 더 고쳐야 할 내용도 많지만 글을 쓰는 데 작은 도움이 되길 바라며 공개합니다.
개발자, 왜 글을 써야 하는가?
개발자는 코딩만 잘하면 된다?! 그렇지 않다. 코드도 일종의 (컴퓨터가 이해하는) 글이다. 개발자는 ‘코드라는 글’을 쓰는 사람이다. 이뿐만이 아니다. 제품이나 서비스는 개발자 혼자서 만들 수 없다. 필연적으로 다양한 직군의 사람들과 협업해야 한다. 따라서 협업의 기본이 되는 글쓰기 역량은 개발자에게도 무척이나 중요하다.
시인 김춘수는 시 ‘꽃’에서 ‘이름’이 가지는 의미를 깊게 통찰하며 존재의 본질을 이야기한다. 한마디로 이름을 가짐으로써 존재를 인식하게 되는 것이다. 글쓰기도 이와 같다. 글을 쓴다는 건 글로 나란 존재를, 내 생각과 지식을 세상에 알리는 것이다. 우물 안 개구리에서 더 큰 세상에 자신을 알리고 나아가는 시작이 ‘글’이다.
아마 당신은 기술 발표를 듣거나 글이나 책에서 지식을 습득했을 것이다. 그러한 글, 발표, 책, 영상은 결국 누군가의 지식 나눔으로 만들어졌다. 지금의 내가 있기까지 많은 이의 ‘나눔’이 있었던 것이다. 지금껏 받기만 했다면, 이제 지식을 나눌 준비가 되었는가?
좋은 글이란 무엇인가?
‘좋은 글’은 무엇일까?
유시민은 좋은 글을 ‘독자의 마음을 얻고 마음을 움직이는 글’이라고 말했다. 대체로 좋은 글이라고 하면 ‘잘 읽히고 이해가 쉬운 글’을 떠올릴 것이다. 저마다의 정의에서 빠지지 않는 한 가지가 있다면, 그것은 ‘독자’일 것이다. 좋은 글이란 ‘독자의 눈높이에 맞는 글’, 독자에게 생각 거리를 던지는 글, 독자에게 인사이트를 주는 글, 독자가 잘 읽고 이해할 수 있는 글처럼, 좋은 내용은 기본이고 항상 독자를 염두에 두고 쓴 글이다.
좋은 글은 어려운 개념도 쉽게 설명한다.
전문 용어로 온갖 멋을 낸 글이 ‘잘’ 쓴 글로 보일 수도 있다. 전문 용어 자체가 문제는 아니다. 만약 대상 독자가 전문 용어를 모른다면? 독자의 눈높이에 맞춰 전문 용어를 쉽게 풀어 설명하거나 독자가 이해하기 쉬운 용어를 쓰는 게 좋을 것이다.
좋은 글은 자신의 지식을 드러내기 위해 용어를 남발한 글이 아니다. 아무리 어려운 개념, 원리도 누구나 읽고 이해할 수 있게 쉽고 명쾌하게 쓴 글이다. 이런 글의 특징의 하나는 시각 자료도 적절히 이용한다는 점이다. 때론 열 줄의 글보다 한 장의 그림이 이해가 더 쉬울 수 있다.
구르미가 생각하는 좋은 기술 글의 요건은⋯
글쓰는 문화를 확산시키기 위해 기술 글쓰기 동호회를 운영했다. 기술 글쓰기 동호회 1기에게 최근에 읽은 가장 좋았던 글 한 편씩 제출하라고 했다. 그 글을 함께 읽고 어떤 점이 좋았는지, 아쉬운 점은 무엇인지 이야기하며 좋은 글이 갖추어야 할 요건을 뽑아봤다. 다음은 기술 글쓰기 동호회 1기 구르미들이 꼽은 좋은 기술 글의 요건이다.
- 실제로 협업에 적용할 수 있는 글
- 편집이 잘 된 글
- 끝까지 읽을 수 있도록 흥미를 이끄는 글
- 가독성이 좋은 글
- 깊이 생각해보지 않으면 얘기할 수 없는 인사이트/내공이 있는 글
- 내가 얻고자 하는 걸 알려주는 글
- 자신의 경험을 다룬 글
- 어려운 것도 쉽게 쓴 글
- 검색이 잘 되는 글
- 핵심을 압축한 제목
- 참조, 레퍼런스가 풍부한 글
- 맞춤법을 준수하고 잘 읽히는 글
- 목차가 있는 글
