명확한 소프트웨어 단계별 사용법을 쓰는 방법

명확한 소프트웨어 시각 문서는 독자에게 무엇을 어디에서 실행하고 성공 여부를 어떻게 확인하는지 알려 줍니다. 완성 결과 하나를 정하고, 정확한 인터페이스 레이블로 직접적인 동작을 쓰며, 확인 지점을 넣고, 유용한 스크린샷과 결합한 뒤 말로 설명하지 않고 가이드를 테스트하세요.

요약: 각 단계를 동작으로 시작하고, 화면에 보이는 제어 항목 이름을 쓰며, 필요한 값이나 조건과 다음 단계로 넘어갈 수 있는 결과를 적으세요.

완성 결과 하나 정하기

완성 결과가 있어야 모든 단계에 이유가 생깁니다. “가이드를 PNG 파일로 내보내기” 또는 “Shotomatic의 화면 녹화 권한 켜기”처럼 독자가 완료하고 확인할 수 있는 작업으로 적으세요.

“편집기 배우기”처럼 넓은 목표는 피하세요. 작성자는 무엇을 넣어야 하는지, 독자는 언제 끝났는지 알 수 없습니다.

각 단계를 동작으로 시작하기

첫 문장은 독자가 할 일을 알려줘야 합니다. 열기, 선택하기, 입력하기, 드래그하기, 검토하기, 내보내기 같은 직접적인 동사로 시작하세요.

두 문장을 비교해 보세요.

수정 전: “내보내기 메뉴는 오른쪽 위에 있으며 여러 유용한 형식을 포함합니다.”

수정 후: “오른쪽 위의 Export 메뉴를 여세요.”

수정한 문장은 독자가 바로 행동하게 합니다. 형식 설명은 선택에 영향을 줄 때만 이어서 적으세요.

정확한 인터페이스 레이블 사용하기

정확한 레이블은 독자가 지침과 현재 화면을 맞추는 데 도움을 줍니다. 화면의 대소문자를 유지하고, 상호작용이 다르다면 메뉴, 버튼, 필드, 탭, 키보드 단축키를 구분하세요.

수정 전: “설정 영역으로 이동해 관련 권한을 켜세요.”

수정 후: “System Settings > Privacy & Security > Screen & System Audio Recording을 열고 Shotomatic을 켜세요.”

독자가 볼 수 없는 내부 제품명은 피하세요. 개발자나 관리자를 위한 문서가 아니라면 공개 인터페이스를 따라야 합니다.

단계마다 결정 하나만 두기

단계 하나에는 의미 있는 동작이나 결정 하나를 담으세요. 실패한 지점을 찾기 쉽고 스크린샷도 맞추기 쉬워집니다.

서로 밀접한 입력과 확인은 함께 둘 수 있습니다.

Document title에 Quarterly review를 입력한 뒤 Save를 선택하세요.

동작마다 별도의 경고, 예상 결과, 분기가 있다면 단계를 나누세요.

중요한 동작 뒤에 확인 지점 넣기

확인 지점은 동작이 제대로 끝났는지 알려 줍니다. 권한 변경, 업로드, 내보내기, 초대, 파괴적인 동작, 시간이 걸리는 전환 뒤에 사용하세요.

수정 전: “Export PDF를 선택하고 계속하세요.”

수정 후: “Export PDF를 선택하세요. 저장 대화상자가 열리면 대상 폴더를 고르세요.”

확인 지점이 있으면 애플리케이션이 이전 화면에 머무는 동안 독자가 폴더를 찾느라 헤매지 않습니다.

관찰 가능한 조건으로 분기 쓰기

분기는 독자가 보거나 확인할 수 있는 조건으로 시작해야 합니다. 일반 경로를 먼저 적고 예외는 바뀌는 단계 가까이에 두세요.

수정 전: “필요하면 권한을 조정하세요.”

수정 후: “창 미리보기가 비어 있다면 System Settings > Privacy & Security > Screen & System Audio Recording을 열고 Shotomatic이 켜졌는지 확인하세요.”

드문 예외를 모두 기본 가이드에 넣지는 마세요. 증상과 원인이 많아 작업을 방해한다면 별도의 문제 해결 페이지로 연결합니다.

위치와 상태는 스크린샷으로 보여주기

텍스트와 이미지는 역할을 나눠야 합니다. 텍스트는 동작, 필요한 값, 조건, 예상 결과를 설명합니다. 스크린샷은 제어 항목의 위치와 관련 화면 상태를 보여줍니다.

화면의 모든 요소를 문단으로 설명하지 마세요. 이미지 위에 전체 지침을 큰 텍스트로 넣는 것도 피하세요. 이미지를 볼 수 없거나 보기 어려워도 독자는 동작을 이해할 수 있어야 합니다.

클릭 마커, 화살표, 도형, 텍스트, 자르기, 흐리기를 고르는 방법은 Mac에서 명확한 지침용 스크린샷에 주석 넣기를 참고하세요.

군더더기와 숨은 가정 없애기

군더더기는 동작을 늦추고 숨은 가정은 작업을 불가능하게 만듭니다. “간단히”, “그냥”, “평소처럼”, “필요에 따라 설정” 같은 표현을 지우고 빠진 요구 사항을 적으세요.

수정 전: “필요에 따라 내보내기 옵션을 간단히 설정하세요.”

수정 후: “PNG를 고르고 Original size를 유지한 뒤 지원 티켓이 증거를 저장하는 폴더를 선택하세요.”

수정한 문장은 독자에게 필요한 정보를 담았기 때문에 더 깁니다. 간결함은 필요한 세부 정보를 지우는 것이 아니라 쓸모없는 단어를 없애는 것입니다.

말로 설명하지 않고 사용법 테스트하기

작성에 참여하지 않은 독자로 테스트하세요. 명시한 시작 조건만 알려 주고 말로 고치지 않은 채 작업을 완료해 달라고 요청합니다.

처음 망설이거나 잘못된 제어 항목을 고르고 예상 밖의 상태에 도달한 지점을 기록하세요. 그 위치의 설명이나 스크린샷을 고친 뒤 처음부터 다시 테스트합니다.

독자가 목표한 결과에 도달하고 모든 분기가 관찰 가능하며 작성자의 기억에 의존하지 않을 때 가이드가 완성됩니다. 클릭 캡처 전체 과정은 Mac에서 클릭으로 단계별 가이드 만드는 법, 현재 도구는 Action Capture에서 확인하세요.