업무를 하다보면 기술 문서를 자주 보게 된다.
문서를 읽어도 이해가 잘 되지 않고 그래서 어떻게 하면 된다는 것인지 알기 어려운 기술 문서.
어떻게 하면 문서를 더 잘 이해할 수 있을까 고민하다가
문서에도 표준과 규칙이 있는 것을 알고 구조적으로 이해한 후 부터는 이해도 능력치가 +1 된 듯하다.
문서는 누군가 읽고 잘 알기 위한 것
문서의 뼈대를 생각(흐름, 포맷)하면서 보도록 하자.
결론
소개 페이지
- 문서가 무엇을 설명하기 위한 것인지 파악
목차
- 소개 페이지의 문서 목적을 체계적으로 설명하기 위한 핵심 내용을 파악
문서의 상세를 설명할때 각 글의 글머리 기호
- 단계, 순서 혹은 방법의 나열
Ⅰ. 문서 구조
A. 구조적 이해 (문서 목차 양식)
1) 표제 페이지 (Title Page)
- 문서의 제목, 저자, 소속, 발행일 등의 정보를 포함.
2) 초록 또는 요약 (Abstract)
- 본문 내용을 간략하게 요약한 부분.
3) 목차 (Table of Contents)
- 섹션 및 장(chapter), 절(section), 부절(subsection) 등의 제목과 해당 페이지 번호를 포함.
4) 본문 (Main Body)
- 실제 내용이 포함된 부분.
5) 참고문헌 (References)
- 문서에서 참고한 자료들의 출처를 나열한 부분.
6) 부록 (Appendices)
- 본문에 추가적인 정보를 보충하기 위해 수록된 부분.
7) 색인 (Index)
- 중요한 용어나 주제에 대한 페이지 번호를 모아둔 목록.
B. 내용의 이해 (글머리 기호)
1) 단계별 글머리 기호 표기
- 순서가 있는 글머리 기호는 그 단계와 순서를 나타낸다.
1, 2, 3, ... (장/섹션별로 번호 매김)
1.1, 1.2, 1.3, ... (하위 섹션)
1.1.1, 1.1.2, 1.1.3, ... (더 하위 섹션)
문자를 이용한 번호 매기기:
I, II, III, ... (장/섹션별로 번호 매김)
A, B, C, ... (하위 섹션)
1), 2), 3), ... (숫자를 이용한 하위 섹션)
기호를 이용한 번호 매기기:
●, ○, ■, ... (장/섹션별로 번호 매김)
▲, ▶, ▼, ... (하위 섹션)
◆, ◇, ◈, ... (더 하위 섹션)
2) bullet 기호 표기
- 방법의 나열
- 내용
- 내용
- 내용위의 문서는 IEEE Style 문서스타일 가이드를 따라 조금 번형하여 작성 해봤다. 😀
IEEE Style Format Guide
I. CENTRED, SMALL CAPS, TITLE CASE - Text begins on a new line (first line indented)
A. Left-Aligned, Italicised, Title Case - Text begins on a new line (first line indented).
1) Indented, italicised, sentence case: Text begins on the same line.
a) Indented further, italicised, sentence case: Text begins on the same line.
CENTRED, SMALL CAPS, TITLE CASE - Text begins on a new line (first line indented).
C. 참고 자료
IEEE Style (Institute of Electrical and Eletronics Engineers Style):
https://www.ieee.org/content/dam/ieee-org/ieee/web/org/conferences/style_references_manual.pdf
APA (American Psychological Association Style)
MLA (Modern Language Association Style)
Chicago Style (Chicago Manual of Style)
