Skip to content

Commit f57b9ac

Browse files
committed
docs: 가치 먼저 제공하기 세부 내용 추가
1 parent 0945684 commit f57b9ac

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

docs/architecture/index.md

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

2424
- 부가적인 정보나 세부 사항은 나중에 배치하세요.
2525
- 기능 중심 설명을 피하고, 독자가 얻을 가치를 먼저 전달하세요.
26+
- 기능-가치-예시 구조로 작성하세요.
2627

2728
### [효과적인 제목 쓰기](./heading.md)
2829

docs/architecture/value-first-cost-later.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,26 @@ import { DoDont } from '@/components/DoDont/DoDont';
6464

6565
</DoDont.Do>
6666
</DoDont>
67+
68+
### ✅ 기능-가치-예시 구조로 작성하세요
69+
70+
기능 설명에 그치지 말고, 이 기능이 왜 유용한지와 기능을 적용할 수 있는 사례를 함께 제시하세요.
71+
72+
<DoDont>
73+
<DoDont.Dont>
74+
75+
자동 백업 기능은 데이터베이스를 주기적으로 저장합니다.
76+
77+
- 기능을 사용하면 좋은 점과 사용 예시를 알려주지 않아서 독자가 이 기능을 왜 써야 하는지를 이해하기 어려워요.
78+
79+
</DoDont.Dont>
80+
<DoDont.Do>
81+
82+
자동 백업 기능은 데이터베이스를 주기적으로 저장하여 장애 발생 시에도 복구할 수 있도록 합니다.
83+
이를 통해 데이터 손실 위험을 최소화하고, 예기치 못한 시스템 다운타임에도 빠르게 서비스를 복원할 수 있습니다.
84+
예를 들어, 매일 새벽 자동 백업을 설정하면 개발 중 데이터 오류가 발생해도 즉시 이전 상태로 되돌릴 수 있습니다.
85+
86+
- 기능 설명과 함께 가치, 사용 예시를 제시했어요.
87+
88+
</DoDont.Do>
89+
</DoDont>

0 commit comments

Comments
 (0)