Skip to content

Commit 02ca0e4

Browse files
committed
docs: 보조 자료 활용하기 문서 추가
1 parent deb1827 commit 02ca0e4

File tree

3 files changed

+53
-0
lines changed

3 files changed

+53
-0
lines changed

docs/architecture/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,9 @@ head:
4444
- 논리적인 순서로 정보를 배치하세요.
4545
- 용어를 일관되게 사용하세요.
4646

47+
### [보조 자료 활용하기](./supplementary-materials.md)
48+
49+
- 예시 코드를 작성하세요.
50+
- 시각 자료를 활용하세요.
51+
- 중요한 정보는 시각적으로 구분하세요.
52+
- 참조할 수 있는 링크를 제공하세요.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
head:
3+
- - meta
4+
- property: og:title
5+
content: 보조 자료 활용하기
6+
---
7+
8+
import { DoDont } from '@/components/DoDont/DoDont';
9+
10+
# 보조 자료 활용하기
11+
12+
좋은 문서는 독자에게 맥락을 풍부하게 제공합니다. 하지만 모든 정보를 한 문서에 담으려 하면 주제가 분산되고, 정보량이 지나치게 많아질 수 있어요. 이때 예시 코드, 사진, 그래프 같은 보조 자료를 활용해야 합니다. 그렇게 하면 독자에게 정보를 더 쉽고 직관적으로 전달할 수 있습니다.
13+
14+
### 1. 독자가 정보를 더 쉽게 이해할 수 있습니다
15+
16+
다이어그램, 순서도, 표 같은 시각 자료를 활용하면 글로 설명하기 어려운 개념이나 절차를 독자에게 한눈에 보여줄 수 있어요. 그래서 정보의 흐름을 더 직관적으로 파악할 수 있어 이해하기 쉬워요.
17+
18+
예제 코드를 함께 제공하면 독자가 직접 실행해 보며 동작을 확인할 수 있어요. 이렇게 하면 문서가 단순한 설명을 넘어 실제 사용 경험을 전달하는 학습 자료가 되며, 독자의 이해도와 몰입도가 함께 높아집니다.
19+
20+
참조 링크를 활용하면 사용자가 스스로 관련 정보를 찾아볼 수 있습니다. 이렇게 하면 문서의 길이를 늘이지 않고도 맥락을 전달할 수 있고, 독자가 주도적으로 학습할 수 있는 여지를 마련해 줍니다.
21+
22+
### 2. 문서의 신뢰도를 높입니다
23+
24+
공식 문서나 자세한 설명으로 연결되는 참조 링크를 활용하면 정보가 검증된 근거를 바탕으로 작성되었다는 인상을 줄 수 있습니다. 독자는 “이 문서는 근거가 있는 정보다”라는 신뢰가 생기는 거예요.
25+
26+
### 3. 중요한 정보를 효과적으로 전달할 수 있습니다
27+
28+
본문의 모든 내용이 동일한 형태로 나열되어 있으면, 독자는 어떤 부분이 중요한지 빠르게 구분하기 어려워요. 이럴 때 콜아웃, 참조 링크, 하이라이트 블록 같은 요소를 활용하면 독자가 주의해야 할 부분과 참고할 부분을 자연스럽게 인지할 수 있습니다.
29+
30+
## 체크리스트
31+
32+
### ✅ 예시 코드를 작성하세요
33+
34+
예제 코드는 핵심 기능을 잘 드러낼 수 있고 간단해야 해요. 그리고 독자가 직접 실행해보며 학습할 수 있도록 예제 코드를 실행하는 데 문제가 없는지 확인해야 합니다.
35+
36+
### ✅ 시각 자료를 활용하세요
37+
38+
시각 자료는 단순히 보기에 좋은 자료보다 전달하고자 하는 정보를 명확하게 보여주는 자료를 선택해야 해요. 독자가 정보를 잘 이해하도록 돕는 목적으로 활용하기 때문이에요.
39+
40+
### ✅ 중요한 정보는 시각적으로 구분하세요
41+
42+
주의 사항이나 추가 정보처럼 독자가 반드시 인지해야 하는 내용은 콜아웃, 굵은 글씨, 색상 블록 등을 활용해 시각적으로 강조하세요.
43+
44+
### ✅ 참조할 수 있는 링크를 제공하세요
45+
46+
문서에서 직접 설명하기 어려운 배경지식이나 세부 정보가 있을 때는 관련 문서나 공식 자료로 연결되는 참조 링크를 추가하세요.

docs/sentence/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ head:
2020

2121
- 문장을 짧고 간결하게 유지하세요.
2222
- 메타 담화를 최소화하세요.
23+
- 괄호 사용을 줄이세요.
2324

2425
### [구체적으로 쓰기](./concreteness.md)
2526

0 commit comments

Comments
 (0)