이 글은 "개발자의 글쓰기"를 읽고 좋은 구절들을 기록하거나 느낀 점을 기록하는 글입니다.
1. 사용자 에러 메시지를 제대로 쓰는 법
사용자 에러 메시지에는 에러의 내용, 원인, 해결 방법이 포함돼야 한다.
내용 -> 원인 -> 해결 방법 순으로 나타낸다.
내용과 원인이 복잡하다면 해결 방법을 제일 먼저 알려 주는 것도 좋은 방법이다.
해결 방법 -> 원인 -> 내용 순으로 나타낸다.
2. 사용자의 에러를 줄이는 메시지 구조화
에러 메시지를 사용할 때 알림 창을 사용한다.아래의 사진은 windows에서 사용하는 알림 창이다.
아래의 사진은 ios에서 사용하는 알림 창이다.
같은 알림 창이 지만 확인, 취소 버튼의 순서가 서로 반대로 되어있다.
OS에 따라서 순서가 달라 무엇을 따라가라고 하기엔 어렵지만
서비스 내에서 일관성을 가지는 것이 좋다.
3. 에러 메시지 대신 예방 메시지를 쓰자
발생한 에러를 처리하는 것보다 에러 자체를 발생하지 않도록 하는 것이 더 좋다.
아래의 사진은 예약하는 사이트에서 자주 사용하는 달력이다.
예약을 하려면 오늘 날짜 이후로부터 예약을 할 수 있다.
만약 어제의 날짜를 선택할 수 있다면 에러 메시지를 띄어주어야 하지만
사진처럼 애초에 선택을 하지 못하게 한다면 에러메시지를 띄우지 않아도 된다.
개발하기 전에 서비스에 대한 충분한 이해를 하고 개발하게 된다면
이처럼 에러 메시지를 띄우는 대신 에러를 발생시키지 않게 할 수 있을 것 같다.
'개발 서적 > 개발자의 글쓰기' 카테고리의 다른 글
| [개발자의 글쓰기] 6장. 수주를 돕는 SI 제안서 쓰기 (0) | 2022.02.19 |
|---|---|
| [개발자의 글쓰기] 5장. 설명, 묘사, 논증, 서사로 개발 가이드 쓰기 (0) | 2022.02.15 |
| [개발자의 글쓰기] 4장. 독자 관점에서 릴리스 문서와 장애 보고서 쓰기 (0) | 2022.02.09 |
| [개발자의 글쓰기] 2장. 개발 시간을 줄여주는 이름 짓기와 주석 쓰기 (0) | 2022.02.03 |
| [개발자의 글쓰기] 1장. 개발자의 글쓰기는 달라야 한다 (0) | 2022.01.24 |