개발자의 글쓰기' 란 책의 가장 뒷 부분에 있는 기술 블로그 쉽게 쓰고 운영하기라는 부분에 나오는 일부 내용을 발췌한다. 이 내용은 두고두고 읽고 인지하면서 글을 쓸 때 참조하면 좋을 것 같기 때문이다.
우선 책에 나온 표를 정리하자면 다음과 같다.
구분 | 내용 | 종류 |
저 | 직접 경함하고 실험한 과정이나 결과 | 개발기, 도입기, 적용기 |
술 | 어떤 것을 분석하여 의미를 풀이하고 해석한 것 | 기술 소개, 용어 분석, 에러 해결 방법등 |
편 | 산만하고 복잡한 자료를 편집해 질서를 부여한 것 | 프로그램 설치/설정 방법, 튜토리얼, 세미나 후기, 책 리뷰 |
집 | 여러 사람의 견해나 흩어진 자료를 한데 모아 정리한 것 | 명령어 모음, 팁, 땡땡가지 규칙 |
저 (著 (나타날 저, 붙을 착)) : 직접 경험한 것을 쓴 것이다. 개발 과정과 결과를 쓴 개발기가 여기에 해당한다. 예를 들면 다음과 같은 글이 있다.
- 분산 웹 캐시의 개선 과정
- Dagger적용기
술 (述 (펼 술)) : 은 어떤 것을 분석해 의미를 풀이하고 해석한 것이다. 인문학에서 술은 경전을 해설한 글을 말한다. 성경이나 불경, 성인의 말씀을 풀이한 책이 모두 술에 해당한다. 우리가 서점에서 사서 읽는 논어 같은 인문학 도서는 거의 술이다.
개발에서 술은 새로운 기술을 자세하게 또는 비유해 설명한 것, 비슷한 용어를 비교해 풀이한 것, 에러 해결 방법 등이 여기에 해당된다. 예를 들면 다음과 같은 글이 술에 해당한다.
- GET과 POST의 차이
- MySQL Ascending index vs. Descending index
편 (編 (엮을 편, 땋을 변)) : 순서를 요약하여 쓰자. 편은 산만하고 복잡한 자료를 편집해 질서를 부여한 것이다. 우리나라 역사 교과서를 집필하는 곳이 국사편찬위원회인데, 여기서도 '편' 이라는 글자를 사용한다. 그 이유는 역사를 고대사부터 현대사까지 시간 순서로 설명하기 때문이다. 그래서 보통 편은 시간 순서로 일어난 일이나 해야 할 일을 쓴 것을 통칭하기도 한다. 프로그램 설치나 설정 순서, 개발 방법, 튜토리얼, 개발자 컨퍼런스 후기 같은 것이 여기에 해당한다.
- 사용하면서 알게 된 Reactor, 예제 코드로 살펴보기
- 간단하게 구축해보는 Javascript 개발환경
편을 쓰는 방법은 저술보다 쉽다. 시간 순서로 하나씩 나열해 내용을 쓴 다음, 단계로 묶어서 요약하기만 하면 글이 완성되기 때문이다.
집 (輯 (모을 집)) : 글쓰기가 두렵다면 자료를 모아 핵심을 엮어서 쓰자. 집은 여러 사람의 견해나 흩어진 자료를 한데 모아 정리하는 것이다. 자료가 아니라 비슷한 여러 책을 한데 모아 출간한 것을 전집이라고 하는데, 이때 '집'은 단순히 여러 책을 모은 것이고, 지금 얘기하는 '집'은 자료를 모아 하나의 책으로 엮은 것을 뜻한다.
집은 여러 자료를 책 한 권에 모은 것이니 내용을 이것저것 아무렇게나 다 집어넣을 수가 없다. 그래서 자료나 견해에서 요점이 되는 것만 모아야 하는데, 그렇게 해서 쓴 책을 '집요' 라고 한다. 우리가 잘 아는 집요로는 율곡 이이의 '성학집요', 이암이 중국 원나라에서 들여온 '농상집요' 등이 있다.
집은 내용을 많이 쓰는 것이 아니라 핵심만 간결하게 정리한 것이다. 그래서 글 전체가 길지 않고 내용이 각각 나열되어 있다. 기술 블로그에서는 명령어 모음, 팁, 땡땡가지 규칙 같은 것이 집에 해당한다.
- 자바스크립트 정규표현식 코딩법
- 스크롤과 관련된 CSS속성 3가지
상기 내용은 '개발자의 글쓰기' 중에서 발췌하였다.
'사는 이야기 > 좋은 글' 카테고리의 다른 글
사흘, 3일을 뜻하는 순우리말 (1) | 2020.08.24 |
---|---|
생각의 독립 (0) | 2020.07.22 |
객관적 묘사와 주관적 묘사. (0) | 2020.07.15 |
의사결정을 객관적으로 하는 방법 (0) | 2020.07.09 |
나에게 하는 말 (0) | 2020.01.13 |