개발자가 소통을 하는 과정에서 모든것을 직접 현장에 가서 화면을 보면서 설명할 수 있다면 글쓰기가 필요 없을지도 모른다. 하지만 대부분의 상황에서는 가이드를 주거나 글로써 설명해야 하는 경우가 많다. 고로 글을 잘 써야 한다.
나도 블로그를 작성하며 글쓰기를 익히고 있는 상황이고 배운 내용을 적용하여 글쓰기 단계를 보이고자 한다.
기술 글쓰기
기술 글쓰기란 무엇이고, 왜 어려운지, 어떻게 작성해야되는지 알아보자
기술 글쓰기의 특징
특정 독자를 대상으로 특정 목적을 가지고 특정 정보를 전달한다.
어떤 작업을 수행하거나 어떤 주제를 쉽게 이해할 수 있도록 정확한 정보만을 전달해야 한다
| 내용 | 사실 |
| 대상 | 특정인 |
| 형식 | 형식적,표준에맞게,학문적 |
| 구성 | 순차적 |
어려운 이유
- 뭘 써야될 지 모르겠다
- 구성을 짜기 너무 힘들다.
- 쓰다보면 처음에 계획했던 내용과 달라진다
- 생각을 문장으로 표현하기 어렵다 등...
글쓰기 작성 과정(POWER)
참고링크
1. P : Pre Writing - 주제, 대상독자, 작성도구선정, 일정수립
2. O : Organization - 문서 구조잡기 : 수평,수직 구조 고려
3. W : Writing - 내용작성
4. E : Editing - 문서 구조 확인, 문법 및 맞춤법 수정
5. R : Re-writing - 검토의견 반영
기술 글쓰기 과정 : 아날로그 시계 읽는 법
P : Pre Writing
제목 : 아날로그 시계 읽기 가이드
주제 : 아날로그 시계 읽는법과 원리를 설명합니다.
대상 독자 : 이 문서의 독자는 수리적 사고력이 있는 개발자이다. 간단한 수식 계산 지식이 필요하다
독자의 기대 반응 : 아날로그 시계를 읽고 원리를 이해할 수 있다
O : Organization
목차와 간단한 개요 :
1. 아날로그 시계란?
2. 아날로그 시계 동작 원리와 읽는 법
2.1 예제로 보는 시계읽는 법
3. 참고하면 좋은 링크
주의사항
제목 수준을 3단계 이하로 유지한다
W : Writing
쓰여진 목차를 활용하여 Top-Down 방식으로 작성
주의사항
목록은 강조하는것으로 모든 항목이 목록이면 전체를 강조하지 않은것과 동일함(ppt같이 쓰지 않도록 유의)
코드 삽입시 간단한 설명 필수
문장은 형식성을 지니고 정확, 선명, 간결해야 한다
핵심정보 + 부가정보 순서로 작성한다
E : Editing, R : ReWriting
초안으로 작성된 문서는 항상 검토하자!!
시간이 지난 후에 다시 읽어보기(독자의 관점으로)
소리내어 읽어보기
동료 검토
작성된 글 예시
아날로그 시계 읽기 가이드
아날로그 시계란?
일반적인 아날로그 시계의 형태
디지털 시계는 아라비아 숫자로 시간을 알려주는 반면 아날로그 시계는 시침, 분침, 초침이 각각 해당 시간을 가리키는 형태를 의미한다. 여기서 시침, 분침, 초침이란 일반적으로 제일 굵고 짧은 것이 시침, 길면서 굵은것이 분침, 얇고 긴 것이 초침을 의미한다.(그림참고) 원형의 형태로 원을 360˚로 생각했을 때 6˚마다 작은눈금이 표기되어 있고, 30˚마다 큰 눈금이 표기되어 있다.
- 시계의 특징에 따라 숫자가 표기되어 있지 않은 경우와, 작은눈금이 표기되어 있지 않은 경우가 있다.
- 원형이 아닌 네모난 아날로그 시계도 있다. 똑같이 원의 개념으로 공간을 나누면 된다.
- 디지털, 아날로그가 아닌 시계는 해시계, 물시계 등이 있다.
아날로그 시계 동작 원리와 읽는 법
초침은 1초마다 작은눈금 1칸만큼 움직이며, 분침은 1분마다 작은눈금 1칸만큼 움직이고, 시침은 1시간마다 큰눈금 1개만큼 움직인다. 각 해당 눈금을 읽으면 시간을 읽을 수 있다. 0시 0분 0초를 기점으로 오전과 오후가 나뉘게 된다.
시간을 읽는 방법은 다음과 같다.
- 시 : 1~12 까지의 숫자(큰 눈금) 중 시침이 가리키는 방향의 숫자이다. 숫자 사이에 있다면 작은 쪽이 현재 시 이다.
- 위 그림에서는 10번째 큰 눈금과 11번째 큰 눈금 사이에 있기때문에 10시 이다.
- 분 : 작은눈금이 총 60개가 있고, 분침이 가리키는 눈금을 읽으면 되나 한번에 계산하기 복잡한 경우 시침을 먼저 읽고, 5를 곱한다음 가장 앞에있는 시침으로부터 지나온 분침의 개수만큼 더해주면 된다.
- 위 그림에서는 분침이 1번째 큰 눈금과 2번째 큰 눈금 사이에 있고, 1번째 큰 눈금에서 작은눈금 3칸만큼 이동해 있기 때문에, 5*1+3 = 13분이다.
- 초 : 가장 빠르게 움직이고 있는 바늘이 초침이다. 읽는 방법은 분과 같다. 1분에 한 바퀴 회전한다.
- 위 그림에서는 초침이 6번째 큰 눈금과 7번째 큰 눈금 사이에 있고, 6번째 눈금에서 작는눈금 2칸만큼 이동해 있기 때문에, 5*6+2 = 32초이다.
예제로 보는 시계읽는 법
다음 예제를 통해 시간을 읽어보자
- 시침은 10과 11사이를 가리키므로 10이다.
- 분침은 큰눈금 1번째와 2번째 사이이므로 1*5 + 3 = 8 이다
- 초침은 큰눈금 8번째와 9번째 사이이므로 8*5 + 2 = 42 이다
이를 종합하면 10시 8분 42초이다.(만약 오후 라면, 시간에 12를 더해서 22시 8분 42초)
참고하면 좋은 링크
디지털과 아날로그 : 네이버 백과사전
초(시간)의 개념 : 위키백과
느낀점
초안으로 작성된 글에서 상당히 많이 발전된 형태이다. 아직 부족한점이 있겠지만, 이러한 피드백(동료피드백)을 받으면서 작성된 글이 퀄리티가 높아진다는 것을 알게 되었고, 개요 작성하는것과 적절한 그림의 삽입, 작성이후 피드백과 재작성은 글을 쓸 때 꼭 하는 습관을 들여야 겠다.
