WTD(Write the docs) 밋업

20190323-write-the-docs.adoc

20190323 WTD(Write The Docs)

Write the docs 소개

• read the docs: 사람들이 조금 더 문서를 많이 읽었으면 좋겠다.

  • Eric holscher: 문서화를 주제로 커뮤니티를 시작하고 싶은데 여러분이라면 어떻게 하겠는가?

• 2013 년부터 컨퍼런스가 시작되고 있다.

• 다양한 행사를 진행하고 있다.

  • 워드 커밍험(위키 시스템을 처음 만든 사람)

• 하는 일

  • 문서화에 대한 이야기

  • technical.writethedocs.org

  • 도시별 밋업

• 파이컨에서 하위 행사로 시작

• 태그 #wtdseoul

글쓰는 개발자 모임 - 글또, 변성윤(쏘카)

• 블로그를 만든 사람들은 많지만 꾸준히 블로그에 글 쓰는 사람은 적음

• 트레바리?

• 얼또 → 따라하기 → 글또(글쓰는 또라이가 세상을 바꾼다. )

• 첫 모임은 꼭 오프라인에서 진행

• 어떤 글을 작성할 것인가?

  • 번역

  • Error 해결 방안

  • 행사 참여 후기

  • 프로젝트

  • 회고/일지 글

  • 많은 사람들이 궁금해하는 내용

• 글을 재미있게 쓴다는 것은 어떻게 쓰는 걸까? → 잘 읽어지는 문장으로 좋은 내용을 담을 수 있으면 된다고 생각한다.

Note	정리 글쓰기는 습관이다. (강제로)글을 쓸 수 있는 규칙을 세워라.

기술 블로그 생존 전략: 구글 시대의 글쓰기, 김대권(당근마켓)

• 44bits.io 생존전략

우리는 왜 글을 쓸까요?

→ 내가 쓴 글을 누군가가 읽도록 하기 위해서다.

기술 블로그 유입경로

• Social

• Organic search

Social

• 즉각적인 반응: 기분이 좋아요

• 잘 공유되면 유입량이 폭발적으로 늘어남

• 짧은 생명력: 짧으면 3일, 길면 7일

• 팔로워가 없으면 효과가 없다.

Organic search == 구글 검색

• 지속적인 유입: 짧아도 몇개월, 길게는 영원히

• 느린 반응: 예측이 어렵다.

  • 구글검색에 노출되기 위해서 해야할일은?

• 구글은 수집된 문서들 중에서 검색 키워드에 대해서 가장 추천할만한 글을 정렬해서 보여준다.

• Search Quality Rating General Guidelines: 구글이 밝히는 검색 노출결과 가이드라인

  • 좋은 기술 블로그를 만들어나가기 위한 8가지 제언

  • 구글은 사이트가 아니라 웹문서를 찾아준다.

• 사이트보다 웹문서의 품질을 높여라.

좋은 글을 쓸 수 있는 방법

• (완결된)문서

  • 메타데이터 보다는 제목과 본문이 중요하다.

  • 좋은 제목은 아무리 강조해도 지나치지 않다.

    • 좋은 제목은 본문의 핵심 키워드를 포함하고 있어야 한다.

    • 좋은 제목은 본문을 잘 드러내야 한다.

    • 좋은 본문이 없다면 좋은 제목도 가치가 없다.

  • 컨텐츠 SEO 의 핵심은 질 좋은 컨텐츠

    • 구글은 질 좋은 컨텐츠를 알아 볼 수 있다.

  • 지양해야 하는 글 = 추천할 가치가 없는 글들

    • 완성되지 않은 문장들로 작성된 글

  • 완성된 글을 작성한다.

  • 글을 적절한 분량으로 작성한다.

    • 7분 내에 읽을 수 글

    • 짧은 뉴스는 2000~3000

    • 긴 튜토리얼은 20_000 ~ 30_000

    • 긴 글은 나눠서

  • 형식을 가지고 작성한다.

• 블로그

  • 튜토리얼

  • how-to

  • 해설

  • 뉴스기사

  • 에세이

웹 사이트

• 컨텐츠 관리가 가능한 도구를 사용한다.

• 길게 보고 블로그를 운영한다.

• 전략

  • 아직 좋은 글이 별로 없는(!) 적당한 범위의 키워드를 정한다.

  • 처음에 글을 쓰면 잘 노출되지 않는다.

Note	정리 적당한 분량으로 잘 정돈된 형식을 가지고 글을 쓴다. 이 때 핵심 단어를 제목과 본문에서 기재한다.

To. 지식 공유를 시작하려는 개발자, From. 당신의 든든한 서포터 DR(Developer Relation팀), 홍연의(Line)

• 입사한지 4개월

• 가장 많이 받은 질문: DR팀이 하는 일은 무엇일까? Dev Rel팀(데브릴)

• 개발자를 만나기 위해 커뮤니티 활동을 시작했다.

  • 이상한모임: 강민경님 → 커뮤니티 재미에 눈뜸

• 번아웃! 너무 많이 했다.

• 출판사 근무경험 + 커뮤니티 활동경험

Developer advocate

• 입사 전:라인 개발자의 전문성을 세상에 알리고 개발자 활동을 지원하는 것!

• 입사 후

  • 기술 블로그 운영

    • 사내개발자 기고글 관리, 행사 후기, 개발자 인터뷰

  • 페이스북, 트위터

  • 개발 컨퍼런스, 세미나, 커뮤니티 후원

  • 개발자 대상 행사 주최

    • Link DEV

    • Developer Meetup

  • 사내 테크 토크/ 라이팅 토크

Dev Rel 팀

• 컨텐츠, 스폰서십

  • 라인 개발자와 개발자 문화를 세상에 알릴 수 있는 일

  • 라인의 개발자들이 좀더 쉽게 지식 공유할 수 있도록 돕는 일

To. 지식 공유를 시작하려는 개발자에게

• 지식공유방식

  • 블로그, 책, 영상, 강의 발표

  • 쉽지 않은 이유: 시간, 잠, 사람, 친구, 수명…​

Note	정리 개발 활동과 관련하여 DR 업무를 하는 이가 주변에 있다면 도움을 요청하라. → 아니면 라인으로…​

사용자를 외면하지 않는 릴리즈 노트, 조은별(서큐아이)

• 테크니컬 라이터가 하는 일

  • 사용자 메뉴얼

  • 릴리스 노트

  • API 문서

  • 화이트 페이퍼

  • UI 용어/메시지

  • 개발 계획서

  • 테스트 계획서

  • 기술 블로그(온라인 컨텐츠)

  • IT 도서

우리가 접하는 릴리스 노트들

• 필요 항목

  • 개선 기능

  • 수정 사항

• 어떻게 작성하는지에 따라 제품에 대한 신뢰성을 추가할 수 있다.

분야별 릴리즈 노트

• 게임 유저를 위한 릴리즈 노트

• 개발자를 위한 릴리즈 노트

릴리즈 노트 작성시 고려사항

• 제품/사용자 특성: 누가 읽는 것인가?

• 일관된 문서 포맷: 어떻게 읽는 것인가?

• 세 줄 요약: 무엇을 읽는 것인가?

Note	정리 장황한 문서를 일정한 양식을 가진 형태로 작성한다.

개발자는 왜 블로그를 해야하나요? 이동욱(우아한형제들)

• jojoldu.tistory.com

• 블로그에 대한 이야기

• 우아한형제들 회사소개

• 1년새 영업이익 768% → 76.8%

• 블로그: 총 266개( 1주 1개 이상 블로깅)

  • 주제: Java, Spring, JetBrain, AWS, MySQL, 이직, 고민 상담 등

  • 평일(5000~6000), 주말(1500~2000)

  • 누적 PV 100만 → 10개월에 한번씩 100만 돌파

  • 다음/카카오톡 직장IN 메인에 올라감

• 퍼스널 브랜딩

  • 블로그 개선

    • 테마

    • 블로그 댓글 방식 변경

    • 에디터: 마크다운(markdown-tistory)

• 나는 블로그를 좋아하고 개선하고 혜택을 본 사람

• 블로그 장점

  • 광고비

    • 매일 1~5, 매월 60~70, 누적 1337

    • 광고가 있다면 클릭해주세요

  • 기고 & 집필 요청: 출판제의, 신간 도서 추천평, 신간 도서 칼럼, 잡지 기고 등등

    • 나의 글로 부수익 창출!

  • 세미나 초대권

    • 참가후기 등을 작성하면서 세미나에서 초대받음

  • 다른 회사의 위키에 내 블로그가 링크됨 → 나는 유명해졌다!!

  • 인터뷰

  • 이직제의

  • 사내 기술 블로그: 작성 요청에 부담이 없음(적음)

    • 직간접적인 사내 블로그 정책 공유: 야 너두 기술블로그 쓸 수 있어.

왜 블로그를 해야하나요??

→ 블로그는 나를 표현하기 좋은 수단이다.

Note	정리 블로그는 개발자가 자신을 알릴 수 있는 좋은 수단이다. 블로그는 여러분을 표현해줍니다. 나는 jojoldu.tistory.com의 블로거 이동욱이다.

개발 관련 기술 블로그 운영하기, 변정훈(BlockchainOS)

• 블로그 운영한지 12년 된 고인물(이 아니라 썩…​) 블로거

• 글 작성

  • 3일에 글 1개 작성 목표

  • 글 1개에 짧게는 2~4시간

  • 글 1개에 길게는 2~3일

  • 퇴고는 잘 하지 않는다.

• 글 주제

  • 개발하면서 적을 수 있는 건 전부

  • 새로운 도구, 환경 설치/설정

  • 새로 알게된 라이브러리/도구 사용법

  • 최근에 겪고 있는 장애와 해결방법

  • 개발 관련 공유할만한 내용

Note	글 쓸 주제는 항상 생각하고 있다.

• 나는 중간자다.

글의 흐름

• 하고자 했던일(컨텍스트)

• 경험한 문제 상황 정리

• 시도해본 방법

• 왜 동작이 안되는가? 왜 동작하는가?

• 문제 상황 재현

• 예제코드

• 관련 링크

• 개념 설명

MCVE

• Minimal, Complete, Verifiable, Example

• 알고있는 내용이더라도 글로 적으려면 공부가 많이 필요하다.

• 공유 문화

  • 공유를 통해 남의 경험에서 배우고 시간을 줄인다.

• 일하면서도 글을 많이 작성한다.

글을 지속적으로 쓰려면 어떻게 해야하는가?

• 글쓰기가 내 근육이 되었다.

기술 블로그는 돈이 되는가?

• 안됩니다(단호).

  • 노력대비 돈이 되지 않는다.

Note	정리 아웃사이더, 그는 12년 묵은 블로그다.

정리

• 글을 쓰는 것은 누군가가 읽어주길 바라기 때문이다.

• 꾸준하게 글쓰기를 위해서는 원칙을 세우고 이를 지키려 노력해야 한다.

• 누군가가 읽어주길 바란다면 일정한 양식을 가지고 쓰는 것이 좋다.

• 글은 완성하여 공유해야 한다.

• 블로그는 자신을 표현할 수 있는 좋은 수단이다.

• 기술블로그는 평일에 트래픽이 집중된다.

• 반복적인 노력을 통해 글쓰기력을 키워야 한다.

Note	나도 honeymon.io 에 꾸준하게 글을 좀 늘려보…​