Skip to content

Commit 0945684

Browse files
committed
docs: 보조자료 활용하기 - do/don't 사례 추가
1 parent 57e22d4 commit 0945684

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/architecture/supplementary-materials.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,31 @@ import { DoDont } from '@/components/DoDont/DoDont';
4141

4242
주의 사항이나 추가 정보처럼 독자가 반드시 인지해야 하는 내용은 콜아웃, 굵은 글씨, 색상 블록 등을 활용해 시각적으로 강조하세요.
4343

44+
<DoDont>
45+
<DoDont.Dont>
46+
이 설정을 변경하면 서비스 전체가 재시작되므로 주의해야 합니다. 변경 전에 트래픽이 없는 시간대를 선택하세요.
47+
- "주의해야 한다" 라는 표현만으로는 시각적으로 강조되지 않습니다. 중요한 정보가 본문에 묻힐 수 있어요.
48+
</DoDont.Dont>
49+
<DoDont.Do>
50+
::: warning 주의
51+
이 설정을 변경하면 서비스 전체가 재시작됩니다. 변경 전에 반드시 트래픽이 없는 시간대를 선택하세요.
52+
:::
53+
- 굵은 글씨와 색상으로 중요한 정보이라는 것을 인지할 수 있습니다.
54+
</DoDont.Do>
55+
</DoDont>
56+
4457
### ✅ 참조할 수 있는 링크를 제공하세요
4558

4659
문서에서 직접 설명하기 어려운 배경지식이나 세부 정보가 있을 때는 관련 문서나 공식 자료로 연결되는 참조 링크를 추가하세요.
60+
61+
<DoDont>
62+
<DoDont.Dont>
63+
자세한 설정 절차는 API 인증 가이드를 참고하세요.
64+
65+
- 문서 이름만 언급하고 링크를 제공하지 않아서 사용자가 직접 경로를 찾아야 합니다.
66+
</DoDont.Dont>
67+
<DoDont.Do>
68+
자세한 설정 절차는 [API 인증 가이드]()를 참고하세요.
69+
- 관련 문서를 링크로 연결해 편하게 정보를 확인할 수 있습니다.
70+
</DoDont.Do>
71+
</DoDont>

0 commit comments

Comments
 (0)