Docs

docs/system/ux-writing.md

UX writing

화면에 나가는 문구를 어떻게 적는지 정한다. 무엇을 적을지는 서비스가 소유하며, 이 문서는 같은 뜻을 적을 때 갈라지지 않아야 하는 표기와 문장 형태만 다룬다.

가운뎃점

가운뎃점은 두 가지 다른 일을 하고, 둘의 구분은 앞뒤 공백으로 드러난다.

  • 붙여 쓰는 ·는 같은 종류의 항목을 하나의 이름으로 묶는다. 「목록·상세」, 「공지·자료」, 「본사에 제안·의견」이 이에 해당한다. 묶인 전체가 하나의 이름이므로 항목 사이에 공백을 넣지 않는다.
  • 띄어 쓰는 ·는 종류가 다른 값을 한 줄에서 구분한다. 첨부 카드의 「PNG · 828 KB」가 이에 해당한다. 파일 종류와 파일 크기는 서로 다른 값이며 하나의 이름으로 묶이지 않으므로 붙여 쓰지 않는다.
  • 서술로 이어지는 문장의 나열에는 가운뎃점을 쓰지 않고 반점을 쓴다. 「정책, 메뉴, 제도 개선 등 본사가 검토할 의견」처럼 「~ 등 ~」으로 이어지는 보기는 셋이 각각의 예이므로, 점으로 묶으면 하나의 이름으로 읽혀 보기라는 것이 사라진다.

묻는 문장

  • 화면이 사용자에게 묻는 문장은 서술어와 종결어미를 갖춘다. 「어떤 내용인가요」는 서술어가 없는 명사구라 무엇을 하려는 것인지가 빠진다. 「어떤 내용을 보내시겠어요?」처럼 목적어와 서술어와 종결어미를 갖춰 적는다.
  • 칸 이름과 묻는 문장을 가른다. 값을 받아 적는 칸은 components/field.md의 Label로 이름을 달고, 사용자에게 무엇을 하려는 것인지 되묻는 자리는 묻는 문장으로 세운다. 한 화면에 둘이 함께 있어도 된다. 선택지가 그 물음의 답이 되는 자리가 뒤쪽이다.

앱의 다른 자리를 가리킬 때

  • 문장 안에서 앱의 다른 메뉴나 화면 이름을 가리킬 때는 낫표로 감싼다. 「이 내용은 사장님 앱의 「지원요청」에 등록됩니다」처럼 적는다. 이름이 조사와 붙어 있어 감싸지 않으면 어디까지가 이름인지 읽히지 않는다.
  • 주변 글이 oe-foreground-tertiary인 안내 문구에서는 그 이름만 oe-foreground-secondary로 한 단계 올린다. 굵기는 바꾸지 않는다. 안내 전체는 물러나 있어야 하고, 그 안에서 사용자가 찾아가야 할 곳은 이름 하나이기 때문이다.