Skip to content

Commit 157b5f8

Browse files
committed
docs: 제목 수정하기, 코멘트 반영하기
1 parent 3e7a9f8 commit 157b5f8

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/architecture/background.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ head:
88
import { DoDont } from '@/components/DoDont/DoDont';
99

1010

11-
# 필요한 정보 챙기기
11+
# 자세히 설명하기
1212

1313
문서는 반드시 독자의 이해 수준에 맞게 작성해야 해요. 독자는 이 문서를 처음 읽기 때문에 설명하려는 주제에 대한 배경지식이 부족할 수 있어요.
1414
독자가 내용을 이해하기 위해 꼭 필요한 정보를 생략하면 내용을 스스로 추론해야 하기 때문에 오해가 생기고, 문서를 이해하는 데 불필요한 인지 부담이 생겨요.
@@ -48,13 +48,13 @@ import { DoDont } from '@/components/DoDont/DoDont';
4848

4949
<DoDont>
5050
<DoDont.Dont>
51-
sessions[].duration: 세션의 지속 시간을 나타냅니다.
51+
`sessions[].duration`: 세션의 지속 시간을 나타냅니다.
5252
- 설명이 지나치게 짧아서 지속 시간이 어떻게 결정되는지, 단위는 무엇인지 알 수 없습니다.
5353
</DoDont.Dont>
5454

5555
<DoDont.Do>
56-
sessions[].duration: 세션의 지속 시간으로, 사용자가 로그인을 유지한 시간을 의미합니다.
57-
세션이 수동 로그아웃으로 종료된 경우에는 실제 이용 시간, 시간 초과로 자동 종료된 경우에는 마지막 활동 시점까지의 시간을 나타냅니다.
56+
`sessions[].duration`: 세션의 지속 시간으로, 사용자가 로그인을 유지한 시간을 의미합니다.
57+
세션이 수동 로그아웃으로 종료된 경우에는 실제 이용 시간을 나타냅니다. 시간 초과로 자동 종료되었다면 마지막 활동 시점까지의 시간을 나타냅니다.
5858
단위는 밀리초(ms)입니다.
5959
- 누락된 정보가 없어서 독자가 이 값이 무엇인지 정확히 이해할 수 있습니다.
6060
- 단위를 명시해서 데이터를 잘못 입력하는 경우를 방지했습니다.

docs/architecture/index.md

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

47-
### [필요한 정보 챙기기](./background.md)
47+
### [자세히 설명하기](./background.md)
4848

4949
- 새로운 개념이 등장하면 설명을 덧붙이세요.
5050
- 기능이 동작하는 방식을 안내하세요.

rspress.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export default defineConfig({
131131
link: '/architecture/predictability',
132132
},
133133
{
134-
text: '필요한 정보 포함하기',
134+
text: '자세히 설명하기',
135135
link: '/architecture/background',
136136
},
137137
],

0 commit comments

Comments
 (0)