2019 WRITE THE DOCS SEOUL 후기 (feat.jojoldu)

2019 WRITE THE DOCS

WRITE THE DOCS 소개

보통 개발자라면 docs 로 된 기술 설명서, Reference를 많이 보게 되는데 
이러한 기술의 문서화에서 시작했다.

첫번째, 변성윤 - 쏘카 데이터 그룹 머신러닝 엔지니어

https://zzsza.github.io/

• 까먹는게 싫어서 개발 블로그 시작

• 글 잘쓰는 것이 힘들다. 꾸준한 노력이 필요하다

• 글또(글쓰는 또라이) 모임을 통해 글 잘쓰는 개발자 양성중

두번째, 김대권 - 당근마켓 소프트웨어 엔지니어

https://www.44bits.io/ko

• 기술 블로그의 주요한 유입경로

  • Social Media : sns 공유 -> 팔로워가 없으면 읽는 사람도 없음, 하루이틀이면 유입이 끝남

  • Organic Search : 대부분의 방문자가 구글 검색으로 들어옴

• 구글은 왜 내 글을 검색엔진에서 보여줄까요?

  • 구글은 수집한 문서들 가운데서 가장 추천해 줄만한 글을 정렬해서 보여 준다.

  • 구글은 사이트가 아니라 웹 문서를 찾아준다. -> 웹 문서 하나하나의 질을 올리자.

• 좋은 제목

  • 내용의 핵심 키워드가 포함 되어야함

  • 본문을 잘 드러내야함

  • 좋은 본문이 없다면 다 소용없다

• 컨텐츠 SEO(Search Engine Optimization : 검색 엔진 최적화)의 핵심은 질 좋은 컨텐츠이다.

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

    • Low Quality Pages 를 알아보는 알고리즘이 있음

    • 문법이 맞지 않는다던지, 기술 Docs에서 조금만 바꿔서 다시 올린 글이라던지

• 완성된 글을 작성하라.

  • 코드만 띡 붙이고 올리면 사이트의 신뢰도를 떨어트린다.

  • 추천 가치가 없는 글

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

    • 링크만 모아놓은 글

    • 설명보다 코드가 긴 글

    • 직접 작성한 내용이 없는 글

• 적절한 분량의 글을 작성하라

  • 7분정도 분량의 글이 사람들에게 가장 많이 읽힌다.

  • 대략 한페이지에 5600자

  • 구글은 2000미만 글 검색 잘 안됨

  • 20000이상 글 검색 잘 안됨

• 기술 블로그에 쓰는 내용들 (좋은 미디어들은 이미 지키고 있는 룰임)

  • 튜토리얼

  • 문제해결

  • 해설

  • 기사

  • 에세이

• PageRank

  • 사용자들한테는 보이지 않음

  • 페이지의 신뢰도가 높아지면 전체 글의 신뢰도가 높아져서 구글에 잘 노출됨

  • 오래동안 운영하면 다른 사이트들이 도태되서 오래 운영하면 순위가 올라감

세번째, 홍연의 - LINE Developer Relations 팀

Developer Advocate 포지션에서 일함 (Line 개발자의 전문성을 공유하도록 지지하는 일) 
하는일 : 사내 개발자가 공유할 만한 일을 하면 그 것을 포스팅하는 기술블로그를 운영 및 세미나 개최 
지식공유 = 누군가 인생에 도움이 된다는 뿌듯함 
라인에 Technical Writing 팀이 있음. 다른 나라에 올리는 글은 번역도 해서 올림

네번째, 조은별 - 시큐아이 Technical Writer

릴리즈 노트 작성 방법 및 콘텐츠 만드는 방법 
관심있는 기술을 따라가는 것이 재미있었음

• Technical Write 하는일

  • 사용자 매뉴얼

  • 릴리즈 노트

  • API 문서

  • 화이트 페이퍼

  • UI 용어 / 메시지

• 릴리즈 노트

  • 소프트웨어가 업데이트 될때마다 업데이트 내용을 제공하기 위해 작성한 문서

  • 문제를 정의하고 해결점을 기술한 문서

    • 신규 기능

    • 개선된 기능

    • 오류 수정

  • 잘써야 되는 이유

    • 사용자에게 디테일에도 신경쓰고 있다는 인상을 줄 수 있음

    • 앱이 개선되고 있다는 인식을 줄 수 있음

  • 깃헙 릴리즈 노트

    • 디자인 이쁨

    • 업데이트 형식 일관성있음

    • 한줄로 간결하게 작성하여 개발자가 한눈에 볼 수 있게 작성함

• 릴리즈 노트 작성시 고려할 것

  • 제품/사용자 특성

  • 일관된 문서 포맷

  • 세 줄 요약

다섯번째, 이동욱 - 우아한 형제들 백엔드 개발자

https://jojoldu.tistory.com/

• 총 266개 글 발행중

  • 플랫폼 - tokiidesu

  • 댓글 - 깃헙 댓글

  • 마크다운 파일을 티스토리에 변환해서 올려주는 node js 프로그램 만듬

• 블로그를 하면 좋은 이유

  • 광고비 나옴

  • 기고 & 집필 요청

  • 세미나 초대권

  • 인지도 높아짐

  • 이직 (마소 잡지 2019년 4월 호에 이동욱님 이직이야기 나옴)

• 유명한 사람

  • JPA ORM 책 쓰신분: 김영한

  • Spring : 이일민(토비)

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

  • 개발자 커리어 나타내주는데 도와줌 - identity

  • 아무리 흐린 잉크라도 좋은 기억력 보다 낫다.

여섯번째, 변정훈 - Block Chain OS

https://blog.outsider.ne.kr/ 
3일에 글 한개 작성하는 것이 목표 
평소에 주제 생각하면서 있음

• 글 쓰는 주제

  • 개발하면서 적을 수 있는것

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

  • 업무 하면서 겪은 트러블 슈팅

• 글 쓰는 이유

  • 배운 것을 안까먹기 위해

  • 트러블 슈팅 한 것을 적기 위해

  • 한번 배운것을 또 찾지 않기 위해

  • 다시 생각해보기 위해

• 글의 흐름

  • 하고자 했던 일

  • 경험한 문제 상황 정리

  • 시도해 본 방법

  • 왜 동작이 안되는가?

  • 문제 상황 재현

  • 예제 코드

  • 관련 링크

  • 개념 설명

• MCVE

  • Minimal - 문제를 재현할 수 있는 가장 적은 코드를 사용해라

  • Complete - 문제를 재현하는데 필요한 모든 부분을 제공해라

  • Verifiable, Example - 문제를 정확히 설명해라

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

  • IT 이슈

  • wiki

  • Slack

공통 의견

어느순간 자신에게 도움이 된다는 것을 알게 됨