190323. Write the docs 밋업 참가

Write the docs

밋업도 열고 구인구지도 하고 문서화에 대한 다양한 이야기를 진행한다.

글쓰는 개발자 모임, 글또

변성윤님(쏘카 데이터 그룹 머신러닝 엔지니어)

네이버 블로그를 통해 글을 꾸준히 쓰던 습관 형성
까먹는게 싫어서 개발 블로그 시작

글또?- 글쓰는 똘아이가 세상을 바꾼다
10마넌을 넣어넣고 주니어개발자들 끼리 진행했다. 글을 안쓰면 마넌씩 삭감
여러가지의 규칙을 만들어 놓고 진행해나감..(월 2개의 포스팅을 작성, 800자이상 등…)

어떤글을올렸나?
에러가 왜 발생했을까? 해결방안만 올리지 않고 원인을 정리, 프로젝트 진행하는것, 회고(1년 주기로) 등..

13명의 글을 2주마다 피드백을 통해 더 나은 글을 목표로함
점검은 오타, 전개바식, 이해 가능성, 가독성, 이미지 품질.

지금까지 낙오자 없이 잘 끝났다!

성과 : 구성원들의 글쓰기 역량 향상! 높은 충성도! 이직할때 도움(실제로 도움을 받았다고 하심!)! 양질의 글로 개발 생태계에 기여 사람을 만날수 있는 연결고리!
결론 : 글을 쓰는건 쉽지 않지만 함꼐하면 꾸준히 할수 있따! 물론 예치금이 중요하지만 ㅋㅋ


기술블로그 생존전략: 구글시대의 글쓰기

김대권님(당근마켓 인프라 클라우드 개발)
44bits.io 운영 중

우리는 왜 글을 쓸까요? 읽히기 위해서!
사람들을 어떤 경로를 통해 블로그로 접근할까?
Social, Organic Search 검색이 주요 유입원.
SNS의 경우 생명령이 짧다. 짧으면 3일 길어봤자 1주일… 그렇지만 즉각적인 반응이 장점!
물론 팔로워가 없으면 효과가 떨어짐…
방치된 블로그의 경우 Organic Search 가 주요 유입원이다.

즉 블로그는 소셜보다 오랫동안 읽혀질 확률이 높다!! 하지만 이는 예측이 어렵다..(즉각적인 반응이 없다)
또한 티끌모아 태산이다!! 신뢰성을 쌓게되면 검색에서의 결과로 뜰 수 있어진다.!!

컨텐츠가 더 잘 발견되기 위해서는 장기적으로 봤을때 검색유입을 목표로 하자
구글을 어떻게 검색결과를 보여줄까???
정밀도, 재현도를고려한다는데 이해하기 어렵다… 검색엔진은 백과사전이 아니라 거대한 추천시스템이다. 즉 수집한 문서들 중 검색 키워드 중 가장 추천할 만한 글을 정렬해서 보여준다.

어떻게 해야 내 글이 검색될까?
문서와 웹 사이트
문서 - 검색엔진이 검색한것은 웹사이트가 아니라 문서이다! 사이트를 잘만드는것도 중요하지만 구성요소 즉 문서를 단단히 하는것이 중요하다.
메타데이터보다는 제목과 본문이 중요하다. 좋은 제목은 아무리 강조해도 지나치지 않음. 핵심 키워드가 포함되고, 본문을 잘 드러내야 한다. 그리고 본문의 질이 좋아야 한다.
구글을 글을 보고 질 좋은 컨텐츠를 알아볼 수 있다. 그러므로 메타데이터는 중요하지 않다고 한것!

질좋은 컨텐츠를 위핸 제언
1.완성된 글을 작성한다.

  • 이상한 글을 쓰면 블로그의 신뢰도를 떨어뜨린다.(예를들어 한줄짜리, 자신의 메모, 완성되지 않은 문장, 설명보다 코드가 긴 글, 링크만 모아놓은 글, 개인노트를 그대로 공개한 글, 직접 작성한 내용이 없는 글)

2.적당한 분량의 글을 작성한다.

  • 7분정도 읽히는글(5600자 정도 즉 7페이지)이 가장 좋다!
  • 그림의 유무 여백에 따라서 다르지만 600~1200자 정도가 적당!!!!!!!
  • 짧은 뉴스는 20003000 긴글을 2000030000 이것보다 길면 나눠서 쓰자!

블로그에 쓸 수 있는글
튜토리얼, 하우투, 해설, 뉴스기사, 에세이

Page Rank
과거에는 페이지의 랭크를 구글에서 제공했다. 페이지의 신뢰도를 쌓아라. 나무위키의 경우에도 잘못된 정보들이 많지만 랭커는 높다.
장기적인 관점에서 잘 운영하는것이 중요하다!!!

처음 블로그를 시작하려면
관심사 -> 키워드 -> 글쓰기 -> 공유
1.관심사들을 정리하고 키워드를 정하여 구글에서 검색해보자. 아직 좋은 글이 별로없는, 적당한 범위의 키워드를 정하자.
2.5000자 이상의 글을 작성하자. 제목에는 반드시 키워드를 포함하자.
3.게시하고 공유하고 기다려라.


지식 공유를 시작하려는 개발자

홍연의님(LINE+ Developer Realations 팀)

Developer Realations팀에 어떻게 가게 되었나요? IT출판사에서 IT도서 기획 편집자로 일을 시작했다.
다양한 커뮤니티 활동을 진행했다. 또한 책을 만들어내기 위해 저자의 전문지식을 잘 가공해서 지식공유를 돕는일을 진했했었다. DE팀에서 라인 개발자달의 전문성을 세상사람이 알 수 있게 해는것.

하는일 : 사내개발자 기고 글관리 등…개발자 대상 행사 주최. 라인의 개발자와 개발자 문화를 세상에 알릴 수 있는 모든 일. 라인의 개발자가 쉽게 지식 공유할 수 있도록 돕는 일

지식공유를 시작하려는 개발자에게...
블로그, 책, 영상, 강의, 발표등을 통해 지식고유를 할 수 있지만 쉽지만은 않다. 지식공유를 통해 인생의 또다른 기회를 갖게될 수 있따. 기회뿐만이 아니라 누군가에게 도움이 된다는 뿌듯함을 얻을 수도 있다.


사용자를 외면하지 않는 릴리스 노트

조은별님(시큐아이, 보안회사 테크니컬 라이터)

테크니컬 라이터는 어떤 일은 하나요?
기술사업 분야에서 특정사용자를 대상으로 기술적인 정보를 제공하는 문서를 제작.
사용자메뉴얼, 릴리스노트, API문서, 화이트 페이퍼, UI용어/메시지 등….

릴리스 노트의 정의
문제를 정의하고 해결점을 기술한 문서. 즉 소프트웨어가 업데이트 될때 마다 업데이트 정보를 제공하기 위해 요약되어 작성되는 문서
신규기능, 개선된기능, 오류수정..

릴리스 노트의 필요성
앱스토어에서도 자주 보여진다. 자세하게 어떤부분이 어떻게 업데이트 되었는지 알려주는것이 매력적이다.
함축적이고 연관된 이슈에 대해 알려주는것도 좋은방법이라 할 수 있다.

릴리스 노트의 포멧
신규기능을 나누고 신규기능에 대한 설명을 통해 직관성을 제공하는것이 좋다.
ex:
[신규기능]
ㅁㅁ메뉴에 xx추가했습니다.

[개선된기능]
보기의 ㅇㅇ을 ㅇㅇ할수있도록 개선했습니다.

릴리스 노트 작성 시 고려할것
1.제품/사용자 특성 : 누가 읽는것인지?
2.일관된 문서 포맷: 어떻게 읽는 것인지?
3.세 줄 요약 : 무엇을 익는 것인지?


개발자는 왜 블로그를 해야하나요?

이동욱님(우아한 형제들, 백엔드 개발자, jojuldu 블로그 운영)

마크타운 파일을 티스토리에 올릴 수 있는 플러그인 개발

플로그를 좋아하고 개선하고 혜택을 받음
블로그를 하면 좋은이유
한달에 1000달러 정도… 출판제의, 신간제의 등 부수익 창출기회. 다른 회사의 wiki에 내 블로그에 링크된다. 멀리서 세미나 발표로, 책으로 보기만 했던 개발자분의 채용추천. 사내 기술 블로그 작성 요청에 부담이 적음.

왜 블로그를 해야하나요
연봉/회사/직위/재산 빼면 나를 표현할 수 있는게 뭐가있을까? 블로그는 자신을 표현할 수 있다.
블로그는 아이덴티티라고 생각한다.

개발 관련 기술 블로그 운영하기

변정훈님(Outsider’s Dev Story 운영)
글 작성
3일에 글 1개 작성목표, 글 1개에 짧게는 24시간 길게는 23일, 퇴고는 잘 하지 않는다.

글의 주제
개발하면서 적을 수 있는건 전부
새로운 도구, 환경 설치/절정
새로 알게된 라이브러리.도구의 사용법
최근에 겪고 해결한 장애와 처리방법
개발관련 공유할 만한 내용

왜 개발 블로그를 운영하는가
공부할게 많으니까. 글쓰는것 공부하는것을 같은것으로 본다.
처음엔 배운걸 자꾸 잊어버려서, 전에 겪어본것들인데 기억이 안나서.
회고와 비슷하다.

어디에 적어놓았는가
개인노트, TIL(Today I learned), 공개블로그

글을 공개로 쓸 때의 장점
글을 정리하려면 잘 알고 있어야 한다. 또한 글로 정리하면서 다시 고민해 볼 수 있다. 명성이 오른다.

글을 흐름
1.하고자 했던일을 적는다.(Context, 왜 웹사이트를 만들고 싶은지, 왜 이기술을 쓰고싶은지, 어떻게 하다가 해당 장애를 만났는지)
2.경험한 문제 상황 정리(격리된 상황, )
3.시도해본 방법(내가아는 지식, )
4.왜 동작이 안되는가? 왜 동작하는가?(가설)
5.문제상황 재현

MCVE
최소한의, 완성된, 입증가능한 예제
(Minimum, Complete, and Verifiable Example)
해결책을 받고싶으면 스택오버플로우에서 이런식으로 질문을 올려라는것!
블로그도 마찬가지이다.!

블로그를 하는 이유?
공유문화를 좋아한다.
일하면서도 글을 많이 작성한다.(Slack, Issue tracker, Wiki)

글을 지속적으로 쓰려면 어떻게 해야 하나요?
블로그를 만들기만 하는 개발자들이 많다. 새로운 스킨적용 스킨 변경의 반복….
열심히 해라 지속적으로 하다보면 근육처럼 붙게된다. 하다보면 어느순간 도움이 된다는것을 깨달을 수 있다.

사람들이 많이 보는 글
자잘한 팁

돈이 되나요?
안됩니다. 돈이 목표라면 기술블로그 보다는 다른영역으로 해라

Share