한 번에 이해되는 사용 설명서 작성법

고객은 고객센터에 문의하고, 신입 직원은 같은 질문을 반복하고, "매뉴얼대로" 한 작업도 여전히 틀어집니다. 대개 원인은 설명서 자체에 있습니다. 작업을 너무 잘 아는 사람이 써서, 처음 하는 사람이 어디서 헤매는지 보지 못한 것이죠. 사용자 가이드든 도움말 문서든 업무 매뉴얼이든, 설명서가 한 번에 통하게 만드는 7가지 규칙을 소개합니다.

1. 설명서 하나에 작업 하나

"계정 설정 방법"은 너무 넓습니다. "비밀번호 변경 방법"과 "팀원 추가 방법"은 별개의 설명서입니다. 독자는 작업 하나를 찾아서, 해내고, 떠납니다.

2. 결과와 준비물부터

처음 두 줄에 독자가 무엇을 얻게 되는지, 시작 전에 무엇이 필요한지 알려 주세요. 접근 권한, 파일, 비밀번호, 10분의 시간 등입니다. 7단계에 와서야 처음부터 필요했던 것이 있었다는 걸 알게 되는 것만큼 답답한 일은 없습니다.

3. 번호 매긴 단계, 단계마다 동작 하나

각 단계는 동작 하나이며, 무엇을 할지가 바로 드러나야 합니다. "설정을 엽니다", "저장을 클릭합니다". 한 단계에 "그런 다음"이 들어 있다면 두 단계입니다. 번호가 있으면 독자는 어디까지 했는지 놓치지 않고, 고객센터는 "4단계를 보세요"라고 안내할 수 있습니다.

4. 내 말이 아니라 독자의 말로

버튼과 메뉴 이름은 독자가 화면에서 보는 그대로 쓰세요. 내부 용어와 약어는 피하고, 꼭 써야 하는 용어는 처음 나올 때 설명하세요.

5. 어떤 결과가 나와야 하는지 보여 주기

중요한 단계 뒤에는 결과를 설명하세요. "초록색 메시지가 나타납니다: 저장됨". 독자는 제대로 가고 있다는 걸 알 수 있고, 뭔가 잘못되면 바로 알아차립니다.

6. 경고는 단계 뒤가 아니라 앞에

"삭제를 클릭하기 전에 데이터를 내보내세요. 삭제된 데이터는 복구할 수 없습니다." 단계 뒤에 놓인 경고는 너무 늦습니다.

7. 처음 하는 사람에게 테스트하기

그 작업을 한 번도 해 본 적 없는 사람에게 설명서를 주고, 돕지 말고 지켜보세요. 망설이거나, 질문하거나, 실수하는 곳마다 다시 써야 할 곳입니다. 5분의 테스트가 한 시간 동안 다시 읽는 것보다 더 많은 문제를 찾아냅니다.

이미지와 구성

• 스크린숏은 화면에서 하는 단계에, 눌러야 할 버튼을 표시해서 넣으세요. 인터페이스가 바뀌면 업데이트하세요.
• 소제목은 긴 절차에 넣어 독자가 필요한 부분으로 바로 갈 수 있게 하세요.
• "이럴 때는" 섹션을 마지막에 두고 흔한 문제를 다루세요. "이메일을 받지 못했다면 스팸함을 확인하세요."

요약

작업 하나, 결과와 준비물 먼저, 번호 매긴 한 동작짜리 단계, 독자의 말, 예상 결과, 제때 하는 경고, 그리고 실제 사람에게 하는 테스트. 사용 설명서, 도움말 문서 세트, 업무 매뉴얼 작성이 필요하다면 사용자 가이드와 SOP를 주문하세요. 제품이나 업무 프로세스를 설명하면 명확하고 체계적인 설명서를 받을 수 있습니다. 대금은 작업을 승인한 후에만 지급됩니다.