[TW] 기술 문서 작성 5단계
카카오엔터프라이즈 기술블로그 Tech&(테크앤)
오늘의 블로그 읽기
주제: 기술 블로그 작성
- 기술 블로그 작성
기술 문서 작성 5단계
https://tech.kakaoenterprise.com/65
개발자의 글쓰기는 다르다. - 글쓰기는 중요하다.
https://dev.gmarket.com/30
- 기술 블로그와 협업
카카오페이 기술 블로그 월 평균 방문자 수 10000명을 넘기까지
https://tech.kakaopay.com/post/kakaopay-techlog-2/
기술 블로그를 다시 디자인하며
https://helloworld.kurly.com/blog/redesign-tech-blog/
- 기술 블로그 운영
개발자가 알아두면 좋은 기술 블로그 운영 팁 5가지
https://yozm.wishket.com/magazine/detail/2134/
요약
- 기술 블로그 작성
SMART 원칙으로 좋은 이름 정하기
| 쉬운 검색, 쉬운 조합, 쉬운 수긍, 쉬운 기억, 쉬운 입력
계층적 구조를 유지하기
| 정확성, 간결성, 가독성
글의 목적과 글의 읽는 대상에 따라 작성하기
테크니컬 라이팅 프로세스
| 기획, 구조화, 문서 작성, 리뷰, 배포
- 기술 블로그와 협업
깃허브를 사용한 리뷰, 피드백에 대한 기준 체크리스트
- 기술 블로그 운영
1. 본인의 경험 또는 생각을 적는다.
2. 글의 주제에서 벗어나지 않는다.
3. 출처까지 한 번 더 검증한다.
4. 사용자가 활성화된 플랫폼을 사용한다.
5. 운영하기 쉬운 방법으로 시작한다.
결론
블로그를 계속 써왔습니다. 이번에 연재와 관련한 스터디를 운영하면서 받은 피드백을 토대로 다시 제가 쓴 글을 돌아보는 시간을 가졌습니다. 나름 구조적으로 괜찮다고 생각했지만, 디테일한 부분은 역시 빠져있었고, 생각과 이론에 대한 구분이 명확하지 않았습니다. 그래서 계층적 구조와 글의 주제에 대한 정확한 명시를 토대로 개선해볼 생각입니다.
![[TW] 기술 문서 작성 5단계](/_next/image?url=https%3A%2F%2Fpubly.imgix.net%2Farticle-thumbnails%2F2023.11%2F28b427b159cf28837a165e622663eb4c0ea38b13159f51e0cbd85b2503aea763.webp%3Fw%3D200%26h%3D200&w=384&q=75)
다음 내용이 궁금하다면?
이미 회원이신가요?
2023년 11월 27일 오전 12:56
댓글 0
함께 읽은 게시물
함께 성장할 주니어 개발자를 찾고 있나요?
안
... 더 보기
< 리차드 파인만의 아버지가 아들에게 전한 인생 조언 >
1. 아버지는 파인먼에게 이렇게 강조해서 말해 주었습니다.
사장이나 리더는 자신의 조직 장악력과 한방향 정렬(Alignment) 역량을 스스로 어떻게 평가하면 좋을까? 이나모리 가즈오 교세라 회장은 초기에는 친목회 참석률로 이를 평가했다. 물론 나중에는 친목회 활동이 기업문화로 정착했기 때문에 더 이상 평가 요소가 아니었지만, 이 질문은 리더의 조직 장악력과 조직 한방향 정렬을 평가하는 데 좋은 질문이 되었다.
... 더 보기•
조회 780
< 스포티파이와 멜론, 같은 음악인데 왜 경험은 다를까? >
1. 엔터테인먼트 프로덕트의 본질은 콘텐츠다. 사용자는 콘텐츠를 소비하며 감정을 느낀다. 재미, 감동, 공포, 희열. 인간의 다양한 감정이 콘텐츠를 통해 꺼내진다.
불확실성이 지속되고 있다. 이제는 너무도 익숙한 상황이다. 이러한 상황을 표현한 ‘영구적 위기(Permacrisis)’라는 단어가 있다. 2022년 영국 콜린스 사전에 등재된 단어다.
... 더 보기나는 가끔 조합형 한글의 아름다움에 대해 생각한다.
그 아름다움은 단순히 예쁜 글꼴이나 정갈한 종이 위의 자소 배열에서 끝나지 않는다. 진짜 매력은, 정밀한 정보 구조와 이산 수학적 규칙성 속에 숨어 있다.
