
이 템플릿 사용
방법(How-to) 문서는 웹에서 트래픽이 가장 높은 콘텐츠 형식 중 하나입니다. Trupeer를 사용하면 무료 방법(How-to) 문서 템플릿으로 시작해 브랜드 가이드라인에 맞게 커스터마이즈하고, 각 문서를 독자가 학습할 수 있는 두 번째 방법이 되는 매력적인 비디오 튜토리얼로 바꿔 몇 시간을 절약할 수 있습니다.
방법(How-to) 문서는 독자가 아주 특정한 상태에 있을 때 읽힙니다. 무언가를 진행 중이지만 제대로 작동하지 않고, 이미 생각보다 더 오래 시간을 썼습니다. 그들은 읽는 것이 아니라, 자신을 막는 부분을 해제해 줄 단서를 찾기 위해 훑어봅니다.
이런 글쓰기 규칙의 거의 전부는 여기서 출발합니다.
방법(How-to) 문서 템플릿 다운로드
형식 | 추천 대상 |
|---|---|
Word (.docx) | 도움말 센터에 게시하기 전 초안 작성 및 검토 |
인쇄용 가이드, 온보딩 패키지, 오프라인 참고 자료 | |
PowerPoint (.pptx) | 방법(How-to)을 트레이닝 덱 또는 워크스루 슬라이드로 전환 |
Google Docs | 실제로 작업을 수행하는 사람과 함께 초안 작성 |
Excel (.xlsx) | 문서 인벤토리: 제목, 담당자, 마지막 검토일, 출처 |
무료, 편집 가능, 워터마크 없음.
방법(How-to) 문서가 실패하는 세 가지 방식
모든 실패는 이 중 하나이며, 각각 다른 해결책이 필요합니다.
관문(Gate) | 독자의 질문 | 무엇이 해결하나 |
|---|---|---|
찾기(Find it) | 이 주제에 대한 문서가 존재하나요? | 제목과 색인 위치 |
확인(Confirm it) | 제 상황에 맞는 올바른 문서인가요? | 첫 부분과 선행 조건 |
완료하기(Complete it) | 정말 끝까지 할 수 있나요? | 단계 품질, 스크린샷, 문제 해결 |
대부분의 글쓰기 조언은 세 번째 관문에 대해 다룹니다. 대부분의 문서는 처음 두 관문에서 실패합니다.
관문 1: 제목
제목이 독자가 사용할 단어와 일치하지 않으면, 독자 입장에서는 그 문서가 존재하지 않는 것과 같습니다.
기능이 아니라 작업을 쓰세요. "CSV로 보고서를 내보내는 방법"은 "내보내기 모듈 사용"보다 낫습니다. 사람들은 자신이 하려는 일을 검색합니다.
그들의 용어를 사용하세요. 기능에 대한 내부 명칭은 고객이 부르는 방식과 다를 수 있습니다. 지원 티켓과 사이트 검색에서 쓰는 표현을 그대로 가져오세요.
동사로 시작하세요. "비밀번호 재설정 방법"은 "비밀번호 재설정: 가이드"보다 더 빠르게 훑힙니다.
충분히 구체적이어야 독점성이 생깁니다. 사용자 유형이 세 가지라면 "사용자 추가 방법"은 모호합니다. "작업공간에 관리자 사용자 추가 방법"은 그렇지 않습니다.
제목당 한 가지 작업. 제목에 "and"가 들어가면 문서가 두 개입니다.
관문 2: 첫 부분
독자가 도착했습니다. 이 페이지가 맞는지 판단하는 데 약 5초가 주어집니다.
첫 부분은 단계가 시작되기 전에 세 가지 질문에 답합니다.
이 문서가 하는 일. 한 문장입니다. "이 문서는 회계 시스템을 연결해 송장이 자동으로 동기화되도록 하는 방법을 보여줍니다."
누구를 위한 것인지. 역할, 권한, 플랜 요구사항 등. "이 작업을 하려면 관리자 권한이 필요합니다."
먼저 필요한 것. 4단계에서 발견하는 방식이 아니라, 1단계 전에 명시합니다.
마지막 항목은 기술 문서에서 가장 흔한 좌절을 막아줍니다. 바로 세 단계를 진행한 뒤, 자신에게 없는 무언가가 필요하다는 사실을 발견하는 상황입니다. 선행 조건은 맨 위에 있어야 합니다.
몇 분이 아니라 그 이상이 걸린다면 예상 소요 시간을 추가하세요. "약 15분 정도 걸립니다"는 지금 시작할지, 나중에 돌아올지 결정하게 해줍니다.
관문 3: 단계
독자가 끝까지 해내거나 포기하는 곳입니다.
단계당 한 가지 행동. 단계에 "and then"이 들어가면 나누세요.
각 단계는 동사로 시작하세요. "설정(Settings)"을 "그다음 설정을 클릭해야 합니다"가 아니라 "설정(Settings)"을 클릭하세요.
무엇을 하기 전에 어디를 말하세요. "오른쪽 상단에서 Export를 클릭하세요"는 먼저 어디를 봐야 하는지 알려줍니다.
그들이 보게 될 것을 이름으로 지정하세요. 버튼 라벨을 정확히, 대문자/소문자도 정확히. 버튼이 "Save & close"라고 되어 있으면 그대로 쓰세요.
번호를 매기세요. 불릿은 순서가 중요하지 않다는 뜻으로 읽힐 수 있습니다.
가능하면 10단계 미만으로. 긴 작업은 하위 제목과 함께 단계(phase)로 나누세요.
결과를 보여주세요. 마지막 단계 이후에 이제 무엇이 사실이어야 하는지 말하세요. "동기화는 매시간 실행됩니다. 통합(integrations) 페이지에서 마지막 동기화 시간을 확인할 수 있습니다."
작업 중간에 '왜'를 설명하지 마세요. 독자는 실행 중입니다. 배우는 중이 아닙니다. 추론은 메모로 넣거나 별도의 개념(concept) 문서에 두세요.
Trupeer에서 이 템플릿을 커스터마이즈하는 방법
1단계: 템플릿 섹션 열기
메인 내비게이션에서 템플릿(Templates) 섹션으로 이동하세요.

2단계: 템플릿 선택 및 열기
작업하려는 템플릿을 아무거나 클릭해 열어보세요.

3단계: 템플릿 보기 확장
필요한 경우 템플릿 보기를 확장해 전체 레이아웃과 세부 정보를 더 명확하게 확인하세요.

4단계: 템플릿 편집
편집(Edit)을 클릭해 선택한 템플릿을 수정하기 시작하세요.

편집기에서 다음을 할 수 있습니다:
새 섹션 추가
서식 규칙 정의 또는 업데이트
로고를 추가하고 위치 및 관련 설정을 조정
5단계: 커스터마이즈한 템플릿 저장
필요한 모든 변경을 마친 후 저장(Save)을 클릭해 업데이트된 템플릿을 내 템플릿으로 저장하세요.

6단계: 템플릿 미리보기 및 미세 조정
커스터마이즈한 템플릿이 어떻게 보이는지 확인하려면 미리보기(Preview)를 여세요.

미리보기 화면에서 필요하다면 계속해서 조정을 직접 진행할 수 있으며, 템플릿이 원하는 대로 정확히 표시되도록 할 수 있습니다.
이 방법(How-to) 문서 템플릿으로 할 수 있는 것
작성에 드는 시간을 절약: 방법(How-to) 콘텐츠에 맞춰 구조가 잡힌 빈 페이지를 건너뛰세요.
검색에서 순위 확보: HowTo 스키마로 잘 구조화된 방법(How-to)은 Google에서 좋은 순위를 얻습니다.
브랜드에 맞게 유지: Trupeer의 브랜드 키트를 사용해 로고, 글꼴, 색상을 적용하세요.
지원 부담 줄이기: 명확한 방법(How-to) 문서는 사용자가 셀프 서비스로 해결하도록 돕습니다.
비디오 워크스루 추가: 텍스트로 설명하기 어려운 단계에 비디오 튜토리얼을 임베드하세요.
글로벌 독자에게 도달: 한 번의 클릭으로 방법(How-to) 문서를 65개+ 언어로 번역하세요.
방법(How-to) 문서 템플릿
섹션 | 내용 |
|---|---|
제목 | 작업 중심, 동사 우선, 한 가지 작업 |
요약 | 이 섹션이 달성하는 것을 한 문장으로 |
이 문서가 필요한 사람 | 역할, 권한, 플랜 |
시작하기 전에 | 선행 조건, 접근 권한, 필요한 정보 |
필요 시간 | 몇 분이 아니라 그 이상일 때 |
단계 | 번호가 매겨진 단계, 단계당 한 가지 행동, 스크린샷 포함 |
결과 | 이제 무엇이 사실이어야 하는지 |
문제 해결(Troubleshooting) | 자주 발생하는 문제 3~4가지 |
관련 문서 | 다음으로 가능성이 높은 작업, 해당되는 경우 개념 문서 |
메타데이터 | 담당자, 마지막 검토일, 제품 버전 |
총 10개 섹션이며, 그중 4개는 짧습니다. 핵심은 단계와 문제 해결입니다.
스크린샷
사용 가능한 방법(How-to) 문서와 지시문 벽(wall of instructions)의 차이입니다.
인터페이스가 명확하지 않은 단계에는 단계당 스크린샷 1장. 모든 단계에 넣을 필요는 없지만, 그렇지 않으면 문서가 스캔이 불가능해질 수 있습니다.
관련 영역만 크롭하세요. 전체 화면 캡처는 독자가 의도한 대상을 찾느라 헤매게 만듭니다.
가볍게 주석을 달아주세요. 박스 또는 화살표 1개. 여러 주석은 서로 경쟁합니다.
위치뿐 아니라 상태를 보여주세요. 단계에서 무언가가 바뀐다면, 단일 이미지보다 '이전/이후(before and after)'가 더 가치 있습니다.
개인 정보나 고객 데이터는 피하세요. 데모 계정을 사용하고, 캡처 모서리에 있는 브라우저 탭과 알림을 확인하세요.
유지보수 비용을 기록하세요. 스크린샷은 모든 인터페이스 변경 때마다 금방 오래되어 버리고, 오래된 스크린샷은 문서 전체에 대한 신뢰를 떨어뜨립니다. 그래서 캡처보다 기록(recording)을 선택하는 것이 가장 강력한 논거가 됩니다.
문제 해결(Troubleshooting)
유능한 문서와 실제로 유용한 문서를 가르는 섹션이며, 가장 자주 누락되는 섹션이기도 합니다.
독자의 말 그대로, 실제로 문제가 되는 3~4가지와 그 해결 방법을 나열하세요.
4단계 이후에 아무것도 표시되지 않습니다. 보통 연결이 권한 부여를 완료하지 못한 경우입니다. 잠깐 기다렸다가 새로고침하세요. 그래도 비어 있다면 계정에 필요한 권한이 없을 수 있습니다.
버튼이 회색으로 비활성화되어 있습니다. 이 작업에는 관리자 권한이 필요합니다. 작업공간을 설정한 사람에게 문의하세요.
작동은 했는데 데이터가 이상하게 보입니다. 현재 월로 기본 설정되는 날짜 범위 필터를 확인하세요.
상상으로 만들지 말고 지원 티켓에서 가져오세요. 문서를 따라 한 뒤 같은 문제를 겪은 사람이 4명이라면, 그 문제는 문서에 포함되어야 합니다.
약한 버전과 더 나은 버전
약함: 사용자는 보고 모듈에서 내보내기 설정을 구성해, 필요에 따라 다양한 형식으로 데이터를 얻을 수 있습니다.
더 나음: 보고서를 CSV로 내보내려면: 1. 보고서를 엽니다. 2. 오른쪽 상단에서 Export를 클릭합니다. 3. CSV를 선택한 뒤 Download를 클릭합니다. 파일은 다운로드 폴더에 나타나며, 보고서에서 현재 보이는 모든 열이 포함됩니다.
약함: 3단계: 통합 설정을 적절히 구성하고 변경 사항을 저장하세요.
더 나음: 3. 회계 시스템에서 API 키를 입력합니다. 4. 동기화(Sync) 빈도를 시간별(Hourly)로 설정합니다. 5. Save & test를 클릭합니다. 녹색의 Connected 라벨이 표시되어야 합니다.
첫 번째 버전은 세 가지 일을 한 단계에서 처리하지만, 제대로 되었는지 확인할 방법이 없습니다. 두 번째는 검증 가능한 결과가 있는 세 단계입니다.
약한 제목: 통합 구성 가이드(Integration Configuration Guide)
더 나은 제목: 회계 시스템을 연결하는 방법
약한 첫 부분: 이 문서는 플랫폼에서 제공하는 내보내기 기능에 대한 개요를 제공합니다.
더 나은 첫 부분: 이 문서는 보고서를 CSV, Excel 또는 PDF로 내보내는 방법을 보여줍니다. 보고서 보기 권한이 필요합니다. 약 1분 정도 걸립니다.
문서 유형: 방법(How-to) 문서
방법(How-to)은 네 가지 유형 중 하나이며, 이를 섞는 것이 문서에서 가장 흔한 구조적 실수입니다.
유형 | 답변 | 독자 상태 | 형식 |
|---|---|---|---|
방법(How-to) | 이 특정 작업을 어떻게 하나요? | 막혀 있음, 작업 중, 조급함 | 번호가 매겨진 단계 |
개념(Concept) | 이게 무엇이고, 왜 이런 방식으로 작동하나요? | 학습 중, 시간이 있음 | 예시가 포함된 본문 |
참고(Reference) | 정확한 값과 옵션은 무엇인가요? | 한 가지를 찾아보는 상황 | 표와 목록 |
튜토리얼(Tutorial) | 처음부터 이걸 가르쳐 주세요 | 새로 시작, 따라 할 의지가 있음 | 해설이 포함된 안내형 시퀀스 |
실수는 방법(How-to) 문서 안에서 개념을 설명하는 것입니다. 독자는 실행 중이며 배경지식을 원하지 않습니다. 대신 개념 문서로 연결하고, 단계는 깔끔하게 유지하세요.
반대로, 개념 문서에 세 단계가 가운데에 묻혀 있으면 아무도 필요할 때 찾지 못합니다.
문서 길이
본능이 시사하는 것보다 짧아야 합니다. 방법(How-to) 문서는 한 가지 작업을 다루고 거기서 멈춰야 합니다.
10단계를 넘어간다면 자연스러운 분할 지점을 찾아보세요. "X 설정 방법"은 종종 실제로는 "X 만들기 방법", "X 구성 방법", "X에 사람을 초대하는 방법" 같은 세 가지 작업이며, 각각은 독립적으로 찾을 수 있고 순서대로 연결해 제공할 수 있는 세 개의 문서가 됩니다.
긴 문서도 관문 1에서 실패합니다. 한 문서에서 여섯 가지 작업을 다루면 제목은 하나뿐이어서, 그중 다섯 가지 작업은 검색으로 찾을 수 없게 됩니다.
형식
Word는 초안 작성과 검토용입니다. 추적 변경 및 코멘트 덕분에 검토 사이클을 관리하기 쉽습니다. 대부분의 문서는 게시 시스템에 가까이 가기 전에 여기서 작성되어야 합니다.
PDF는 인쇄가 필요한 모든 것, 트레이닝에서 나눠주는 자료, 또는 오프라인에서 필요할 때에 적합합니다. 또한 이메일에 첨부하는 고객용 가이드에도 올바른 형식입니다.
PowerPoint는 방법(How-to)이 트레이닝이 될 때 사용하세요. 슬라이드당 한 단계, 각 슬라이드에 스크린샷을 넣으면 워크스루 세션에 잘 맞습니다.
도움말 센터 또는 지식 베이스는 고객이 볼 수 있어야 하고, 찾아볼 수 있어야 하며 검색도 가능해야 하는 모든 것에 적합합니다. 대부분이 여기에 해당합니다. Word와 PDF는 초안 작성 및 배포 형식이지, 게시용 형식이 아닙니다.
문서 유지보수
문서는 조용히 노후화되고, 오래된 문서는 사람들이 따라 하다가 실패하기 때문에 아예 없는 것보다 더 나쁩니다.
문서마다 담당자를 지정하세요. 문서를 작성할 때 기준이 된 제품 버전을 기록합니다. 기능에 영향을 주는 릴리스가 있을 때마다 검토하고, 그 외에는 고정된 주기로 검토하세요.
가장 신뢰할 수 있는 유지보수 신호는, 해당 문서가 다루는 무언가에 대한 지원 티켓입니다. 즉, 문서가 틀렸거나 틀린 게 아니라 찾을 수 없는 상태라는 뜻입니다. 둘 다 수정할 가치가 있으며, 누군가 그것을 확인하고 있는 경우가 아니면 둘 다 보이지 않습니다.
스크린샷은 유지보수 부담이 가장 큰 요소입니다. 그래서 스크린샷을 얼마나 사용하고 어떤 방식으로 제작하는지에 반영할 가치가 있습니다.
작동하는지 측정하기
조회수(Views), 찾을 수 있는지 알려줍니다.
게시 후 같은 주제에 대한 지원 티켓. 줄어야 합니다. 줄지 않는다면 문서가 작동하지 않거나 찾을 수 없는 것입니다.
검색어에 결과가 없는 경우, 어떤 문서가 누락되었는지 보여줍니다.
페이지 체류 시간(Time on page), 신중하게 해석해야 합니다. 길면 철저함을 의미할 수도, 혼란을 의미할 수도 있습니다.
문서 피드백(Article feedback), 도움말 센터에서 제공한다면 유용하지만, 응답률은 보통 낮습니다.
이탈(Deflection), 문서를 본 뒤 지원에 연락하지 않은 사람을 의미합니다.
가장 유용한 단일 지표는 게시 전후의 해당 주제 지원량입니다. 나머지는 모두 대체 지표입니다.
방법(How-to) 문서를 작성하는 방법
사람들이 실제로 무엇을 묻는지 알아보기, 지원 티켓과 사이트 검색에서 확인하세요. 주제를 추측하지 마세요.
제목을 먼저 쓰기, 독자의 말로 작업을 표현한 형태로 작성하세요. 할 수 없다면 범위가 불명확한 것입니다.
작성하면서 직접 작업하기 또는 누군가가 하는 것을 지켜보세요. 기억에 의존해 쓴 문서는 단계를 건너뛰기 쉽습니다.
선행 조건을 발견하는 대로 나열하기.
단계당 한 가지 행동으로 쓰기, 동사를 먼저, 정확한 인터페이스 라벨과 함께.
진행하면서 캡처하거나 기록하기, 나중에 기억으로부터 하지 마세요.
예상 결과를 명시하기.
실제 지원 티켓에서 문제 해결을 추가하기.
도움 없이도 따라 할 수 있게 하기. 그들이 묻는 모든 질문은 결함입니다.
게시한 뒤 해당 주제의 지원량을 확인하기.
9단계는 유일한 진짜 테스트입니다. 이미 작업을 알고 있는 사람이 검토한 문서는 항상 읽기 좋게 보일 것입니다.
모범 사례
독자의 용어로 된 작업 중심 제목.
선행 조건은 항상 1단계 이전에.
단계당 한 가지 행동, 동사 우선.
정확한 인터페이스 라벨, 정확한 대문자/소문자.
스크린샷은 크롭하고 가볍게 주석 처리.
마지막 단계 이후에 예상 결과를 명시.
문제 해결은 실제 티켓에서 가져오기.
문서당 한 가지 작업, 10단계 미만.
개념은 연결만 하고 내장하지 않기.
작업을 해본 적 없는 사람이 테스트하기.
자주 하는 실수
작업이 아니라 기능 이름을 제목으로 짓는 경우.
선행 조건을 4단계에서 발견하는 경우.
각 단계에 세 가지 행동이 들어가는 경우.
"설정을 적절히 구성하세요" 같은 모호한 지시.
인터페이스 라벨을 인용하지 않고 바꿔 말하는 경우.
크롭하지 않은 전체 화면 스크린샷.
스크린샷에 고객 데이터가 보이는 경우.
예상 결과가 없어서 독자가 작동했는지 알 수 없는 경우.
문제 해결 섹션이 없는 경우.
단계 안에서 개념을 설명하는 경우.
한 문서에 여섯 가지 작업이 들어가고, 그중 다섯 가지는 찾을 수 없는 경우.
작업을 실제로 해보지 않고 기억에 의존해 작성하는 경우.
이미 방법을 아는 사람만 검토하는 경우.
인터페이스 변경 후 스크린샷이 절대 업데이트되지 않는 경우.
기억으로 쓰지 말고 작업을 기록하세요
Trupeer AI에서 템플릿을 열고, 문서가 문서 표준에 맞도록 브랜드 키트를 적용한 다음 각 섹션을 직접 편집하세요. 설정은 템플릿 가이드에 있습니다.
방법(How-to) 문서를 비싸게 만드는 두 가지가 있습니다. 첫째, 기억에 의존해 쓰면 자동으로 수행하는 단계를 건너뛰게 되고, 바로 그 지점에서 독자가 막힙니다. 둘째, 스크린샷은 제작이 느리고 인터페이스가 바뀔 때마다 금방 오래되어 버리기 때문에, 많은 문서가 더 이상 존재하지 않는 제품 버전의 모습을 보여주게 됩니다.
기록(recording)은 둘 다 해결합니다. 작업을 한 번 수행하면 Trupeer AI가 실제로 일어난 순서대로 단계가 정리된 작성 문서를 생성하고, 스크린샷도 자동으로 캡처합니다. 여기에 같은 진행에서 나온 내레이션이 포함된 비디오 워크스루도 함께 제공됩니다. 인터페이스가 바뀌면 스크린샷을 다시 찍는 대신 다시 기록하세요.
번역하기로 65개+ 언어로 번역하고, 독자가 찾을 수 있도록 지식 베이스에 해당 세트를 유지하세요.
기록하세요. 브랜드를 입히세요. 번역하세요. Trupeer하세요.
자주 묻는 질문
Word용 무료 방법(How-to) 문서 템플릿이 있나요?
네. Word는 주요 형식이며, 추적 변경을 통한 검토가 게시 시스템에서보다 더 쉽기 때문에 초안을 작성하기에 가장 적합한 장소입니다. 각 섹션에 프롬프트가 포함된 전체 구조가 들어 있습니다. 무료 다운로드, 가입 필요 없음, 워터마크 없음.
Word에서 무료로 다운로드할 수 있는 문서 템플릿이 있나요?
네. 단계별 문서뿐 아니라 어떤 유형의 지침 문서에도 사용할 수 있습니다. 개념, 참고, 문제 해결 문서에도 구조가 그대로 적용되며, 약간의 조정만 하면 됩니다.
PDF용 무료 방법(How-to) 문서 템플릿이 있나요?
네. 인쇄용 가이드 형식으로, 트레이닝 핸드아웃, 온보딩 패키지, 고객이 오프라인에서 필요로 하는 모든 자료에 적합합니다.
PDF용 문서 템플릿이 있나요?
네. 빈 버전과 완성 예시 버전이 모두 있어, 직접 작성하기 전에 완성된 방법(How-to) 문서를 확인할 수 있습니다.
PPT 또는 PowerPoint용 무료 방법(How-to) 문서 템플릿이 있나요?
네. PowerPoint 버전은 방법(How-to)을 트레이닝 워크스루로 바꿔줍니다. 슬라이드당 한 단계로 구성하고, 각 단계에 스크린샷을 넣을 공간도 마련되어 있습니다. 라이브 세션에는 잘 맞고, 이후에는 참고 자료로 쓰기에는 덜 적합하므로 대부분의 팀은 Word 버전도 함께 필요로 합니다.
무료 방법(How-to) 문서 템플릿을 다운로드할 수 있나요?
네. 모든 형식은 계정이 필요 없고, 출처 표기도 필요 없는 무료 다운로드입니다.
가장 좋은 무료 방법(How-to) 문서 템플릿은 무엇인가요?
선행 조건과 문제 해결이 포함된 템플릿입니다. 대부분의 템플릿은 제목과 번호가 매겨진 단계를 제공합니다. 쉬운 부분이죠. 독자들은 4단계에서 누락된 선행 조건을 발견하거나, 문서에 언급되지 않은 문제를 만나면 포기합니다. 이 두 섹션이 바로 그것을 막아줍니다.
방법(How-to) 문서란 무엇인가요?
특정 한 가지 작업을 다루는 짧은 지침 문서로, 지금 바로 올바르게 해보려는 사람을 위해 작성됩니다. 튜토리얼은 처음부터 가르치는 문서이고, 개념 문서는 어떤 것이 어떻게 작동하는지 설명하는 문서라는 점에서 차이가 있습니다.
방법(How-to) 문서에는 무엇이 포함되어야 하나요?
작업 중심 제목, 한 문장 요약, 필요한 권한을 포함한 대상, 1단계 이전의 선행 조건, 필요 시간, 단계당 한 가지 행동이 포함된 번호 단계, 예상 결과, 흔히 발생하는 문제 3~4가지에 대한 문제 해결, 관련 문서, 담당자와 마지막 검토일을 보여주는 메타데이터가 포함되어야 합니다.
좋은 방법(How-to) 문서는 어떻게 작성하나요?
제목은 독자의 말로 작업 형태로 작성하고, 기억에 의존해 작업하는 대신 작성하는 동안 직접 작업하세요. 선행 조건은 발견하는 대로 나열하고, 단계당 한 가지 행동을 정확한 인터페이스 라벨과 함께 작성하세요. 마지막에는 무엇이 사실이어야 하는지 명시하고, 실제 지원 티켓에서 문제 해결 내용을 추가하세요. 그런 다음 도움 없이도 누군가가 따라 할 수 있게 하세요.
방법(How-to) 문서는 얼마나 길어야 하나요?
한 가지 작업이면 충분하며, 이상적으로는 10단계 미만입니다. 더 길어지면 보통 여러 작업이 섞여 있는 경우로, 각각은 별도의 문서로 만들어 순서대로 연결하면 더 찾기 쉽습니다. 긴 문서가 실패하는 이유도 여기에 있습니다. 제목은 하나뿐이라서, 문서 안의 다른 작업들이 검색에서 보이지 않게 됩니다.
방법(How-to)과 튜토리얼의 차이는 무엇인가요?
방법(How-to)은 이미 원하는 것이 무엇인지 알고 있고, 필요한 구체적인 단계가 필요한 사람을 위한 것입니다. 튜토리얼은 초보자를 가르치며, 보통 해설이 포함된 예시와 더 많은 설명이 함께 제공됩니다. 독자 상태가 차이입니다. 방법(How-to) 독자는 조급하고 작업 중인 상태이며, 튜토리얼 독자는 학습할 시간을 따로 마련해 둡니다.
방법(How-to) 문서에 스크린샷을 포함해야 하나요?
인터페이스가 명확하지 않은 모든 경우에는 네. 관련 영역으로 크롭하고 가볍게 주석을 달아주세요. 모든 단계에 넣을 필요는 없지만, 그렇지 않으면 문서가 스캔이 되지 않게 됩니다. 스크린샷은 문서에서 유지보수 부담이 가장 큰 요소이며, 모든 인터페이스 변경 때마다 오래되어 버리므로, 12개를 추가하기 전에 그 가치를 따져보세요.
방법(How-to) 문서는 얼마나 자주 검토해야 하나요?
해당 기능에 영향을 주는 모든 릴리스 이후에, 그리고 그 외에는 고정된 주기로 보통 6~12개월마다 검토하세요. 가장 유용한 트리거는 이미 문서가 다루고 있는 내용에 대한 지원 티켓입니다. 즉, 문서가 틀렸거나 찾을 수 없는 상태라는 뜻입니다.
이 방법(How-to) 문서 템플릿을 커스터마이즈할 수 있나요?
네. 모든 버전은 완전히 편집할 수 있습니다. 섹션을 문서 표준에 맞게 조정하세요. 다만 선행 조건과 문제 해결은 독자가 가장 자주 문서를 포기하는 두 지점을 다루기 때문에, 어떤 경우에도 유지할 가치가 있는 두 가지입니다.
