📌 문장과 단락을 구조화 하는 법
🏷 문장을 구조화 하는 법
예시 문장
색상 RGB 값을 각각 사용하기 때문에 입력 데이터는 3차원 벡터다.
1. 문장의 주어인 '입력 데이터'를 처음으로 뺀다.
👉🏻 입력 데이터는 색상 RGB 값을 각각 사용하기 때문에 3차원 벡터다.
2. 위의 문장은 인과관계가 있는 복문이므로 두 문장으로 나눌 수 있다.
👉🏻 입력 데이터는 색상 RGB 값을 각각 사용한다. 그래서 입력 데이터는 3차원 벡터다.
3. 예시 문장에서 본인이 제일 잘 아는 내용인 '입력 데이터는 3차원 벡터다'를 떠올리면 위와 같은 문장이 만들어진다.
그 다음, 입력 데이터가 3차원 벡터인 이유를 어떻게 설명할 것인지 결정한다.
👉🏻 입력 데이터는 3차원 벡터다.
변경 된 문장
[입력데이터]
입력 데이터는 3차원 벡터다. 색상 RGB 값을 각각 사용하기 때문이다.
💡 이처럼 간단한 문장 구조로 핵심만 말한 뒤, 필요에 따라 부가 설명을 하면 된다.
🏷 서술식, 개조식, 도식의 차이
서술식은 '~다'로 끝나는 완전한 문장으로 구성된 글을 말한다.
👉🏻 무엇을 설명하거나 논증할 때 주로 사용하는 방식
e.g. 소설, 신문 기사, 개발 가이드
개조식은 신문의 헤드라인을 쓰거나 어떤 사항을 나열할 때 사용한다.
👉🏻 종결 어미(~다) 대신 명사 (완료, 중대 등)나 명사형(~했음)으로 끝내는 것
e.g. 릴리스 문서나 장애 보고서를 쓸 때 개조식으로 작성
도식은 사물의 구조나 관계, 상태를 그림이나 서식으로 보여주는 것이다.
👉🏻 주로 표를 의미
e.g. 행과 열로 이뤄진 표(table), 막대 같은 그림이 있는 도표(graph/chart)
🏷 개조식 서술 방식과 글머리 기호
글을 개조식으로 쓸 때는 글머리 기호를 꼭 써야 한다.
글의 진술 방식
- 설명: 내용을 구체적으로 설명하거나 나열할때 ■, □, ●, ○, -, * 등을 사용 (*하위 요소로 갈수록 크기가 작아지고 들여쓰기를 해야 함)
- 묘사: 내용을 그림으로 나타낼 때 그림 안에 어떤 요소나 영역을 표시하기 위해서는 ①, ②, ⓐ, ⓑ 등의 원형문자를 사용
- 논증: 내용이 논리관계로 구성될 때는 →, >, <, = 등을 사용
- 서사: 순서나 단계를 나타낼 때는 1, 2, 3, 가, 나, 다 등 숫자나 문자를 사용
🏷 단락을 구조화하는 위계
비즈니스 문서에는 문단과 문단 사이에 위계가 있어야 한다.
(*이 때 위계는 위치와 계층을 합한 말)
💡 들여쓰기를 할 때는 띄어쓰기(스페이스)가 아닌 탭(tab)이나 스타일을 사용하자
📌 쉽게 쓰는 띄어쓰기와 문장 부호
🏷 가장 쉬운 띄어쓰기 원칙
띄어 쓰기를 쉽게 하기 위해서 다음 문장을 기억하자.
"조사, 순서, 숫자, 하다, 기호만 붙이고 나머지는 띄어 쓴다."
예시 문장
장애 가 발생 한 지 3 시간 이 지나 버려서 일 단계 대책 이 무의미 하다( v.1.1.0 ).
1. 조사는 모두 앞 낱말에 붙인다.
👉🏻 장애가 발생 한 지 3 시간이 지나 버려서 일 단계 대책이 무의미 하다( v.1.1.0 ).
/* 코딩에서 조사와 비슷한 것이 쉼표이다. 쉼표는 앞 낱말에 붙여야 한다. */
// 안 좋은 예
const obj = {
arg1: 1
, arg2: 2
, arg3: 3
};
// 좋은 예
const obj = {
arg1: 1,
arg2: 2,
arg3: 3
};
2. 일, 이 삼과 같은 한글 숫자가 순서나 단계를 나타낼 때는 뒤 낱말과 붙인다.
👉🏻 장애가 발생 한 지 3 시간이 지나 버려서 일단계 대책이 무의미 하다( v.1.1.0 ).
3. 숫자는 모두 뒤 낱말과 붙인다.
👉🏻 장애가 발생 한 지 3시간이 지나 버려서 일단계 대책이 무의미 하다( v.1.1.0 ).
4. '~하다'는 모두 앞 낱말과 붙인다.
👉🏻 장애가 발생한 지 3시간이 지나 버려서 일단계 대책이 무의미하다( v.1.1.0 ).
5. 기호를 모두 앞 낱말과 붙인다.
👉🏻 장애가 발생한 지 3시간이 지나 버려서 일단계 대책이 무의미하다(v.1.1.0).
// 안 좋은 예
wordSpacing( arg1, arg2 )
// 좋은 예
wordSpacing(arg1, arg2)
🏷 오해하기 쉬운 문장 부호(큰따옴표, 작은따옴표)
개발 언어마다 큰따옴표(double quotes)와 작은따옴표(single quotes)를 구분하는 기준이 다르다.
- C언어 에서 작은따옴표는 단일 문자, 큰따옴표는 문자열에 사용
- SQL은 쿼리문 안에서 모두 작은따옴표를 사용
- 자바스크립트는 주로 작은따옴표를 사용
/* C언어 */
// 잘못된 예
char str[] = 'HELLO WORLD';
str[0] = "A";
// 좋은 예
char str[] = "HELLO WORLD";
str[0] = 'A';
한글에도 따옴표 규정이 있다.
- 글에서 직접 대화를 표시하거나 말, 글을 인용할 때 → 큰따옴표 사용
- 인용한 말, 마음속으로 한 말을 쓸 때 → 작은따옴표 사용
비즈니스 문서에서 따옴표는 겹낫표(『 』)와 겹화살괄호(≪ ≫)대신에 큰따옴표를 쓴다.
- 이번에 출간된 "개발자의 글쓰기"를 참고했음.
- 이 건은 "한겨례신문"의 기사를 토대로 작성했음.
소제목이나 예술 작품의 제목, 상호, 법률, 규정 등을 나타낼 때 쓰는 홑낫표(「 」)와 홑화살괄호(< >)대신에 작은따옴표를 쓴다.
- 이번 프로젝트의 이름은 '안드로이드'로 정했음.
- 이번 릴리스는 '개인정보 보호법'을 준수함
어떤 내용을 강조하거나 비교해서 드러내야 할 때 작은 따옴표를 쓰기도 한다.
- 1단계로 '원인 분석'을 철저히 한 다음 2단계를 추진해야 함.
- 이 시점에서 중요한 것은 '창의'가 아니라 '열정'임.
