본 포스팅은 도서 개발자의 글쓰기의 7장 내용을 참고하여 내 생각도 기록함.
기술 블로그의 종류는 다양하다
- 직접 개발한 과정
- 튜토리얼
- 개발 가이드
- 에러나 버그를 해결하는 방법
- 세미나 후기
- 책 리뷰
- 스스로 깨달은 교훈
- 각종 레퍼런스
- 개발 상식...
등등 너무나 많은 종류가 있다.
본 책에서는 이를 4가지 종류별로 구분해 목차를 잡아 구조화하는 방법을 설명한다.
기술 블로그의 4종류. 저, 술, 편, 집
| 구분 | 내용 | 종류 |
|---|---|---|
| 저 | 직접 경험하고 실험한 과정이나 결과 | 개발기, 도입기, 적용기 |
| 술 | 어떤 것을 분석하여 의미를 풀이하고 해석한 것 | 기술 소개, 용어 분석, 에러 해결 방법 등 |
| 편 | 산만하고 복잡한 자료를 편집해 질서를 부여한 것 | 프로그램 설치/설정 방법, 튜토리얼, 세미나 후기, 책 리뷰 |
| 집 | 여러 사람의 견해나 흩어진 자료를 한데 모아 정리한 것 | 명령어 모음, 팁, OO가지 규칙 |
저 : 개발기는 목차를 잘 잡아서 본문부터 쓰자
어떤 일지를 작성하면 시간의 흐름대로 1 다음 2, 2 다음 3... 이런 식으로 1차원적인 글쓰기를 하면 쉽다.
하지만 개발기를 작성할 때 가장 어려운 문제가 있다.
개발이 순차적으로 잘 된다면야 개발 순서대로 일지를 써 나가면 되지만 개발은 중간중간 버그도 생기고 이를 해결하기 위해 다른 절차도 거쳐야 한다.
결국 개발기는 2차원적인 이야기로 풀이된다.
이를 위해서는 개발을 완료한 뒤 성공한, 완벽한 개발 순서에 대해 1차적으로 작성한다.
이에 대한 것은 아키텍쳐나 알고리즘, 모델, 플로우 등이다.
이후에 문제 해결에 대한 절차는 다음에 문제 해결이나 팁으로 정리해 덧붙인다.
책에서는 네이버 기술 블로그가 가장 체계적으로 잘 쓰여있다고 한다.
목차 정리
1. 머리말
가. 서비스 설명
나. 개발의 필요성
2. 본문
가. 아키텍처나 알고리즘
나. 개발 모델(최종 루트)
다. 개발 과정에서 발견한 문제와 해결 방법(경험 루트)
라. 남은 작업
3. 맺음말
가. 소감이나 회고본문 -> 맺음말 -> 머리말 순서대로 써 보자.
술 : 원전을 비교하고 실험해 풀이해서 쓰자
술이란 어떤 것을 분석해 의미를 풀이하고 해석한 것이다.
- 새로운 기술을 자세하게 또는 비유해 설명한 것
- 비슷한 용어를 비교해 풀이한 것
- 에러 해결 방법
등등이 개발에서 술에 포함된다.
본래 내용 정리 -> 자신의 생각이나 분석, 비교, 해설 덧붙이기
기술 블로그는 어떤 경우에도 모두 통용되는 완벽한 답을 낼 수 없다.
자기 방식대로 풀이하자. (그렇다고 틀리게 적으면 안 됨.)
옳고 그림의 문제가 아니라 특정 상황에서 이렇게 하는 것이 낫다는 정도로만 쓴다고 생각하면 부담이 덜할 것이다.
