스크린샷 기반 소프트웨어 문서 세트를 설계하는 방법

팀마다 소프트웨어 페이지를 다르게 구성하면 시각 문서 세트를 관리하기 어려워집니다. 독자가 묻는 질문부터 정리하고, 각 답변에 맞는 페이지 유형을 지정하세요. 그런 다음 스크린샷 규칙을 정하고, 가치가 큰 가이드부터 만든 뒤 서로 연결합니다. 마지막으로 각 페이지를 누가 검토할지 기록합니다.

핵심 요약: 제품 메뉴가 아니라 독자의 작업을 중심으로 문서를 구성하세요. 질문마다 명확한 답변 하나를 두고, 불확실성을 줄이는 곳에만 스크린샷을 사용합니다. 화면이 바뀌었을 때 각 가이드를 누가 업데이트할지도 기록해 두세요.

독자가 답을 찾는 질문을 나열합니다

문서 목록은 모든 화면을 둘러보는 내용이 아니라, 독자의 질문에서 시작해야 합니다. 지원 요청, 온보딩 세션, 영업 인계, 릴리스 의견, 제품 분석에서 반복되는 작업과 문제를 모읍니다.

각 항목을 완료할 작업이나 내려야 할 결정으로 적으세요.

• 앱을 설치하고 필요한 권한을 허용합니다.
• 선택한 창을 캡처합니다.
• 문서를 이미지 파일로 내보냅니다.
• 화면 미리보기가 보이지 않는 문제를 해결합니다.
• Action Capture와 Auto Capture 중 하나를 선택합니다.

표현이 달라도 같은 질문이면 하나로 묶습니다. 여러 팀이 제목만 다른 비슷한 답변을 각각 만드는 일을 막을 수 있습니다.

질문마다 페이지 유형을 하나씩 지정합니다

페이지 유형에 따라 독자가 기대하는 구조가 달라집니다. 작업에는 튜토리얼, 전체 옵션에는 참고 문서, 증상과 해결책에는 문제 해결 페이지, 변경 사항에는 릴리스 노트를 사용하세요.

독자의 질문	알맞은 페이지 유형	주요 내용
이 기능은 어디에 쓰나요?	개요	목적, 적합한 상황, 제한 사항, 다음 작업
이 작업을 어떻게 끝내나요?	튜토리얼	준비 사항, 순서가 있는 단계, 결과
각 옵션은 무엇을 하나요?	참고 문서	전체 항목, 값, 기본 설정
왜 실패하나요?	문제 해결	증상, 원인 확인, 해결 방법, 확인 자료
무엇이 바뀌었나요?	변경 기록	출시된 동작, 이전 방법에서 옮기는 법, 제공 범위

한 페이지에서 다른 페이지로 연결할 수 있지만, 답변 전체를 반복하지는 마세요. 개요 페이지에는 튜토리얼의 모든 단계를 복사하지 말고, 해당 튜토리얼로 이동하는 링크를 둡니다.

스크린샷 규칙을 정합니다

스크린샷 규칙을 정하면 시각 자료가 있는 페이지를 일관되게 만들고 관리할 수 있습니다. 이미지가 필요한 때, 화면에 표시해도 되는 정보, 현재 작업 대상을 표시하는 방법, 원본과 편집 파일을 저장할 위치를 명시하세요.

다음 내용을 보여 줄 때 스크린샷을 사용합니다.

• 버튼이나 섹션의 위치
• 화면에 보이는 옵션 중 선택할 항목
• 작업 전후의 상태
• 성공적으로 완료된 결과
• 경고 또는 오류의 식별 정보

정확한 명령어, 자주 바뀌는 값, 개념 설명, 독자가 복사해야 하는 정보는 글로 적는 편이 좋습니다. 명령어 스크린샷은 코드 블록보다 접근성이 떨어지고 사용하기도 어렵습니다.

교체하기 쉬운 파일명과 저장 방식을 사용합니다

파일명이 바뀌지 않으면 이미지를 더 안전하게 업데이트할 수 있습니다. 캡처한 순서가 아니라 가이드와 단계의 목적을 기준으로 이름을 붙이세요.

예를 들어 action-capture-start-session.webp는 두 번째 단계였던 문단이 세 번째로 옮겨져도 의미가 유지됩니다. screenshot-02-final.webp는 다음 편집 후 어떤 이미지인지 알기 어렵습니다.

가이드 또는 유지관리 기록에 다음 정보를 함께 보관하세요.

• 원본 캡처
• 편집하고 최적화한 이미지
• 대체 텍스트
• 제품과 운영체제 버전
• 캡처 날짜
• 페이지 담당자
• 자사 이미지가 아닐 때의 출처 또는 라이선스

제품 전체 소개보다 작업 가이드부터 만듭니다

작업 가이드는 독자가 자주 수행하는 일이나 지원 비용이 크게 드는 실수를 다뤄야 합니다. 설정, 첫 성공 결과, 자주 반복하는 작업, 실패했을 때 비용이 큰 경로부터 만드세요.

가이드 하나는 완성된 결과 하나만 다룹니다. "내보내기의 모든 것"처럼 범위가 넓은 페이지는 따라 하기도, 업데이트하기도 어렵습니다. "Action Capture 페이지를 PNG로 내보내기"를 따로 만들고, 모든 형식과 플랜 요구 사항은 별도의 참고 표에 정리하세요.

Action Capture는 작업 중 클릭으로 진행하는 단계를 모아 줍니다. 캡처, 검토, 편집, 내보내기 절차는 Mac에서 클릭으로 단계별 가이드를 만드는 방법을 참고하세요.

문서 세트를 연결합니다

탐색 구조는 독자의 다음 질문을 따라야 합니다. 설정 가이드에서 첫 작업으로 연결하고, 작업 가이드에서는 자주 생기는 문제의 해결 페이지로 연결할 수 있습니다. 참고 문서에서는 옵션을 실제로 쓰는 절차로 돌아가는 링크를 둡니다.

링크 문구에는 목적지를 바로 알 수 있는 이름을 사용하세요. "자세히 알아보기"보다 "화면 기록 권한 허용하기"가 유용합니다. 관련 링크 목록이 전체 문서 구조를 대신하지 않도록 간결하게 유지합니다.

독자에게 어떤 페이지를 열어야 하는지 알려 주지 않은 채 문제를 제시해 문서 세트를 테스트하세요. 올바른 답변을 찾고, 작업을 마치고, 예상되는 오류에서 복구할 수 있는지 확인합니다.

담당자와 검토 조건을 지정합니다

모든 시각 자료 페이지에는 담당자와 검토를 시작할 조건이 필요합니다. 정기 검토도 도움이 되지만, UI, 플랜, 권한이 바뀌거나 같은 지원 요청이 급증하면 예정일보다 먼저 확인해야 합니다.

다음 항목을 기록하세요.

페이지 담당자:
확인한 제품 버전:
마지막 검토일:
다음 정기 검토일:
검토 조건:
- UI 라벨 또는 화면 배치 변경
- 작업 절차 또는 권한 변경
- 플랜 또는 내보내기 변경
- 반복되는 지원 문제

중요한 질문마다 명확한 답변 하나를 찾을 수 있고, 제품 변경의 영향을 받는 페이지를 팀이 식별할 수 있으면 문서 세트가 준비된 것입니다. 클릭으로 진행하는 시각 단계에는 Action Capture를 사용하고, 캡처부터 편집, 내보내기까지의 절차는 Mac에서 클릭으로 단계별 가이드를 만드는 방법을 참고하세요.