본문 바로가기

테크니컬 라이팅

7월 우아한테크세미나 - 개발자도 글을 잘 써야 한다고요?! 리뷰

반응형

확실하게 데브렐 팀이 진행하는 테크세미나는 뭔가 활력이 넘치네요. 최근에 슬랙에서 진행한 세미나도 그렇고 이번 세미나도 그렇구요. 세미나 내용을 정리한 건 아니고 중간중간 개인적인 메모로 남긴 내용입니다. 전체 내용은 공개된 영상을 참고하세요.

 

글쓰기에 진심인 우아한 형제들

우아한 형제 기술 블로그의 월 평균 조회수 15만 회 이상이라고 합니다.
(생각보다 조회수가 많지는 않네요. 일 평균으로 보면 5천 회 정도라서 좀 괜찮은 개인 기술 블로그랑 비슷한 수준인 듯합니다.)

그룹별 글쓰기 모임도 가지고 있음(데브렐팀과 테크니컬 라이터 코치가 같이 참여)

개발자는 지식노동자! 지식의 공유가 곧 기술 커뮤니티를 향한 공헌이자 개인역량과 영향력의 강화입니다.
글쓰기를 통해 지식의 공유를 더 활발히 하고 우아한형제들의 개발자분들이 자신의 역량과 영향력을 더 키워 커리어적 성장을 이룰 수 있도록 적극 지원하고 싶습니다.
- 송재하 CTO

(개발자에게 어떤 역량을 키워줄지는 개인적인 노력도 중요하지만 조직에서 어떤 관점에서 바라보는지도 중요합니다. 요즘 좀 잘 나가는 회사들을 보면 커뮤니티에 대한 공헌을 많이들 강조하더라구요).

 

테크니컬 라이팅 코치

- 어떤 일을 하나요?
글을 쓰고 싶은 구성원을 대상으로 어떻게 시작하고 마무리할 수 있는지 가이드해주고 있습니다.
강의 형식으로 진행하기도 하고 1:1 코칭도 지원하고 있습니다.

- 어떻게 이 일을 시작했나요?
> 유영경 테크니컬 라이터 코치
개발자로 시작했지만 교육, 글쓰기에 관심이 있어서 관련된 일을 찾았습니다.
윈도우 영문 문서를 한글화하는 일을 시작하면서 테크니컬 라이터로 진로를 전환했다고 하네요.
> 김민석 테크니컬 라이터 코치(전)
IBM에서 개발자로 일하다가 데브렐 팀에 합류하고 개발자 블로그 업무도 같이 하게 되면서 글쓰기 코칭 업무를 같이 하게 되었다고 합니다.
(오늘 행사를 진행한 조은옥 님과 같이 IBM 데브렐 팀에서 일했었네요. 이쪽 분야도 다들 연결 연결되는 분위기라).

- 테크니컬 라이터가 되려면 어떤 준비를 해야 하나요?
한국에서는 학문적으로 접근하기는 어렵습니다.
관심이 있다면 계속 관심 있는 분야에 대한 글을 쓰고 기회가 되면 투고도 하는 것을 권장합니다.
글을 쓸 때 항상 독자의 관점에서 쓰는 것이 중요합니다.

 

기술 글쓰기, 어떻게 시작할까

 

고치기 단계가 글쓰기에서 가장 중요한 단계입니다.
(소개해준 문구에는 없었는데 원문 번역을 보면 그 앞에 동료검토에 대한 언급이 있네요~).

시의 병통을 말해 주는 사람이 있으면 기쁜 일이다. 그러나 그의 말이 옳으면 받아들이고 옳지 않으면 나의 뜻대로 할 뿐이다. 어찌 듣기 싫어하기를 마치 임금이 간언을 거절하는 것과 같이 하여 끝내 그 허물을 모르고 넘길 필요가 있겠는가?
무릇 시가 이루어지면 반복 관찰하되, 자기가 지은 것으로 보지 말고 다른 사람이나 또는 평생 심히 미워하는 자의 시를 보듯 하여, 그 하자(瑕疵)를 열심히 찾아도 오히려 하자가 없는 뒤에야 그 시를 세상에 내놓는다.
- 동국이상국전집 제22권 시(詩) 가운데 있는 은미한 뜻을 논한 약언
(한국고전번역원 | 이정섭 (역) | 1978)

 

Q&A

 

- 누가 보는 것이 두려워요?

기술 문서는 팩트를 기반으로 써야 하고 사실에 대해 누군가 딴지를 걸지는 않습니다.
(하지만 대부분 기술 블로그 형식으로 글을 쓰는 경우에는 개인적인 경험, 의견이 포함되기 때문에 조금은 다른 접근인 것 같네요. 테크니컬 라이터와 개발자의 글쓰기는 좀 다르지 않을까 싶네요).

피드백을 받는다면 오히려 감사할 일입니다. 피드백을 바탕으로 글을 수정하면 됩니다.

- 어떻게 하면 이해하기 쉽게 글을 쓸 수 있을까요?

글을 읽을 대상을 머릿속에 특정 인물로 생각하고 이야기하듯 편하게 쓰는 것을 권장합니다.

- 회사에서 사용한 코드는 어디까지 써야 하나요?

회사 내부 가이드라인을 먼저 확인하시구요. 가이드라인이 없더라도 상급자에게 한 번 정도 문의하는 것이 좋습니다.

- 원문 출처는 어떻게 찾나요?

위키, 언론사, 정부 사이트 등을 참고합니다.
(위키 역시 완전히 신뢰하기는 어렵습니다. 위키 자체도 어딘가 출처를 참고해서 작성하는 것이기 때문에 원본 출처는 더 찾아보는 것이 좋습니다).

- 책 인용은 어떻게 하나요?

인용 범위는 걱정하지 않아도 됩니다.
(꼭 그렇지는 않습니다. 요즘은 북튜버라는 이름으로 책을 읽어주는 유튜버들이 있는데 일부 유튜버는 책 전문을 읽어주어서 저작권 위반 소송이 발생하기도 합니다. 출판사마다 다른데 30쪽 미만 정도를 가이드로 제시하기도 합니다.
물론 글쓰기에서는 몇 단락 정도 인용을 하겠지만~)

 

참고: [저작권론] 책·영화 등의 내용을 발췌·요약·낭독하여 블로그·SNS·유튜브 등에 게시할 수 있는가

https://m.blog.naver.com/chjeon/221798934099

 

- 메모는 어떻게 작성하나요?

니콜라스 루만 교수 사례. 제텔카스텐(Zettelkasten) 방식 - 종이에 메모를 적고 분류된 상자에 넣는 것.
관심 분야에 대해 완벽한 문장으로 된 메모를 조금씩 작성해 보자!

옵시디언(https://obsidian.md/)이라는 앱을 사용하고 있음. 개인은 무료지만 유료 옵션이 있음.
(옵시디언은 한 번 자세하게 살펴볼 필요가 있겠네요).

- 맞춤법, 띄어쓰기는 어떻게 잘 지킬 수 있나요?

맞춤법, 띄어쓰기는 무조건 틀렸다는 전제를 하고 검사기 등을 사용합니다.

 

https://www.youtube.com/watch?v=xu3XGEomRWI&t=580s 

 

728x90