훌륭한 매뉴얼은 기업이 만들 수 있는 최고의 레버리지 자산 중 하나입니다. 필요한 사람 누구에게나 지식을 확장해 주니까요. Trupeer를 사용하면 무료 매뉴얼 템플릿으로 시작해, 브랜드 가이드라인으로 커스터마이징하고, AI 매뉴얼 크리에이터로 어떤 매뉴얼이든 영상 워크스루로 전환하여 매뉴얼 작성에 드는 시간을 몇 시간이나 절약할 수 있습니다.

매뉴얼 템플릿이란 무엇이며, 어떤 템플릿이 필요할까요?

매뉴얼은 무언가를 올바르게 하기 위해 누군가가 참고하는 문서입니다. 기계를 작동하거나, 소프트웨어를 사용하거나, 프로세스를 따르거나, 직무를 배우는 경우죠. 매뉴얼 템플릿은 그 문서의 재사용 가능한 구조로, 섹션과 전면(프론트 매터), 그리고 한 매뉴얼이 다음 매뉴얼처럼 보이게 만드는 관례까지 모두 포함합니다.

더 어려운 질문은 지금 작성 중인 매뉴얼이 정확히 무엇이냐는 점입니다. ‘매뉴얼’이라는 단어는 서로 다른 독자, 서로 다른 수명, 서로 다른 법적 무게를 가진 최소 여덟 가지 문서를 포괄하기 때문입니다. 웹 애플리케이션용 사용자 매뉴얼과 산업 장비용 운영 매뉴얼은 이름 말고는 거의 공통점이 없습니다.

이걸 잘못하면 특정한 방식으로 비용이 듭니다. 나쁜 문서가 만들어지는 게 아닙니다. 아래에서 설명하는 실패 방식처럼, 네 가지를 하려다 하나의 문서가 되는 것이죠.

서명자가 두 명인 매뉴얼은 하나의 매뉴얼이 아닙니다

다음은 테스트입니다. 약 1분이면 됩니다.

매뉴얼에 변경이 생겼을 때 승인해야 하는 모든 사람을 나열하세요. 검토하는 사람이 아니라, 승인하는 사람을 말입니다. 문서가 그들 없이는 다시 발행될 수 없다는 의미에서의 승인입니다.

그 목록에 이름이 한 개뿐이면 매뉴얼은 하나입니다. 네 개라면, 누군가가 묶어 둔 네 개의 매뉴얼이 있는 것이고, 그 묶음이 바로 어느 것도 최신 상태로 유지되지 못하는 이유입니다.

메커니즘은 단순하며, 좋은 의도를 완전히 무력화합니다. 서로 다른 사람이 소유한 콘텐츠는 변화 속도가 다릅니다. 안전 선언은 드물게 바뀌고 준수가 필요합니다. 운영 지침은 매 릴리스마다 바뀌며 제품이 필요합니다. 문제 해결은 매주 바뀌고 서비스 팀이 필요합니다. 이들을 하나의 문서로 묶으면, 가장 저렴한 변경이 가장 느린 승인 경로를 그대로 상속받아 아홉 페이지짜리 수정이 이백 페이지짜리 검토를 기다리게 됩니다.

관련된 모든 사람은 매 단계에서 합리적으로 행동하는데도 매뉴얼은 여전히 구식이 됩니다. 그래서 이 실패가 너무 흔합니다. 아무도 잘못을 하지 않기 때문이죠.

따라서 어떤 매뉴얼 프로젝트에서 첫 번째 결정은 템플릿이 아닙니다. 매뉴얼이 몇 개인지, 그리고 그 답은 서명자 수입니다.

Trupeer에서 이 템플릿을 커스터마이즈하는 방법

1단계: 템플릿 섹션 열기

메인 내비게이션에서 템플릿 섹션으로 이동하세요.

2단계: 템플릿 선택 후 열기

작업하려는 어떤 템플릿이든 클릭해 열어 주세요.

3단계: 템플릿 보기 확장

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

4단계: 템플릿 편집

선택한 템플릿을 수정하기 시작하려면 편집(Edit)을 클릭하세요.

편집기에서 다음을 할 수 있습니다:

• 새 섹션 추가

• 서식 규칙 정의 또는 업데이트

• 로고를 추가하고 위치 및 관련 설정을 조정

5단계: 커스터마이즈한 템플릿 저장

필요한 모든 변경을 마친 후 저장(Save)을 클릭해 업데이트된 템플릿을 본인만의 템플릿으로 저장하세요.

6단계: 템플릿 미리보기 및 미세 조정

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

미리보기 화면에서 필요하다면 템플릿이 원하는 대로 정확히 표시되도록 직접 계속 조정할 수 있습니다.

Trupeer의 매뉴얼 템플릿으로 다음을 할 수 있습니다:

• 작성 시간 절약: 어떤 매뉴얼 유형이든 검증된 구조로 빈 페이지를 건너뛰세요.

• 모든 사용 사례 커버: 사용자 매뉴얼, 교육, 운영, 지침, 정책을 위한 템플릿.

• 브랜드에 맞게 유지: Trupeer의 브랜드 키트를 사용해 로고, 글꼴, 색상을 적용하세요.

• 지원 부담 줄이기: 명확한 매뉴얼은 사용자가 셀프 서비스로 해결하도록 도와 티켓과 재작업을 줄여 줍니다.

• 영상 튜토리얼 추가: 텍스트로 설명하기 어려운 단계에 영상도 삽입하세요.

• 글로벌 사용자 도달: 한 번의 클릭으로 매뉴얼을 65+개 언어로 번역하세요.

매뉴얼 유형, 각 문서의 승인 주체, 그리고 변경 주기

승인 주체(approvals) 열을 아래로 읽어 보세요. ‘매뉴얼 문제가 있다’고 생각하는 거의 모든 조직은 실제로 이런 문서가 세 개 또는 네 개가 합쳐져 있는 경우가 대부분입니다.

가장 흔하게 잘못 합쳐지는 두 가지 문서는 교육 매뉴얼과 사용자 매뉴얼입니다. 독자가 서로 다르게 일을 합니다. 하나는 작업과는 떨어진 곳에서 학습하는 것이고, 다른 하나는 그 작업의 한가운데에 갇혀 있습니다. 둘 다를 제공하는 문서는 참고하기엔 너무 길고, 배우기엔 너무 얕습니다.

무료 매뉴얼 템플릿: 모든 매뉴얼이 공유하는 구조

어떤 유형의 매뉴얼을 작성하든, 전면(프론트 매터)은 동일하며 대부분의 초안 작성자가 가장 먼저 건너뛰는 부분입니다. 여기서 복사하세요.

제목과 포함 범위. 적용 대상인 제품, 버전 또는 프로세스를 충분히 정확하게 명시해, 약간 다른 것을 가진 독자는 멈출 수 있어야 합니다.

대상. 역할과 가정된 시작 지식. ‘숙련된 작업자를 위한’과 ‘처음 사용하는 사용자를 위한’은 완전히 다른 문서를 만들며, 독자는 5초 안에 자신이 무엇을 들고 있는지 구분할 수 있어야 합니다.

오너와 승인자. 각각 한 명씩. 두 사람이 다르다면 기록하세요. 그 차이가 이 문서를 얼마나 빠르게 바꿀 수 있는지를 좌우하기 때문입니다.

버전과 날짜. 버전 번호, 발행일, 그리고 이전 버전 이후 무엇이 바뀌었는지 한 줄로 정리합니다.

안전 및 제한 사항. 작업에 위험이 있는 경우에만 해당하며, 부록이 아니라 지침 앞에 배치합니다.

이 매뉴얼을 사용하는 방법. 두세 줄이면 충분합니다. 처음부터 끝까지 읽는지, 중간에 필요한 부분만 찾아보는지, 인덱스가 어디에 있는지, 매뉴얼에 자신의 상황이 포함되지 않을 때 무엇을 해야 하는지입니다.

본문. 위에서 선택한 행(row)에 따라 구조화된, 유형별 전용 부분입니다.

이 매뉴얼이 도움이 되지 않을 때. 일반적인 지원 주소가 아니라, 이름이 있는 경로(루트)로 안내합니다.

여기까지 복사하세요. 버전 줄과 두 이름은 매뉴얼과 문서를 구분하는 필드이며, 누군가 급할 때 가장 먼저 잘라내는 항목이기도 합니다.

이미 작성된 매뉴얼을 분리하는 방법

대부분의 사람은 빈 페이지를 들고 이 페이지에 오지 않습니다. 이미 존재하는 문서를 들고 오기 때문에, 템플릿보다 이 부분이 더 중요합니다.

인쇄하거나 목차 페이지를 여세요. 각 섹션마다 한 가지 이름을 적습니다. 이 변경을 승인해야 하는 사람은 누구인지요. 누가 썼는지는 적지 마세요.

그 이름 기준으로 섹션을 그룹화하세요. 그 그룹이 곧 매뉴얼입니다. 실제로는 보통 세 개 또는 네 개의 그룹과, 아무도 책임지지 않는 고아 섹션(오펀드 섹션) 하나를 발견하게 됩니다. 그리고 고아 섹션은 보통 이미 오래전에 최신이 아닙니다.

가장 아픈 순서대로 분리하세요. 거의 항상 가장 느린 승인 주체 뒤에 숨어 있으면서 가장 자주 바뀌는 콘텐츠가 그 대상입니다. 그곳에 가치가 있고, 보통 준수(compliance) 뒤에 갇힌 운영 또는 문제 해결 콘텐츠입니다.

분리하면서 다시 쓰지 마세요. 텍스트를 그대로 옮기고, 다시 발행한 뒤 나중에 콘텐츠를 수정하세요. 동시에 분리와 재작성은 이 프로젝트를 40%에서 멈추게 만들고 결국 포기하게 만드는 방식입니다.

각 문서에 다른 문서를 가리키는 교차 참조를 남기세요. 그래야 독자가 여전히 이것을 하나의 매뉴얼로 생각하고, 앞으로도 그렇게 생각할 테니까요.

아홉 페이지를 바꾸는 데 11주가 걸린 매뉴얼

Kilnmore Systems는 호텔과 병원을 위한 상업용 세탁 장비를 만듭니다. 출고되는 모든 기계에는 148페이지에 달하는 운영 및 유지보수 매뉴얼이 포함되어 있었습니다.

그 매뉴얼에는 엔지니어링이 승인한 설치 지침, 준수가 승인한 안전 경고 및 적합성 선언, 제품이 작성한 운영 지침, 제품에서 온 세척 일정, 서비스 팀이 작성한 문제 해결, 공급망이 제공한 예비 부품 목록, 법무가 제공한 보증 조건이 들어 있었습니다. 기여자는 7명, 승인자는 4명, PDF는 1개였습니다.

2024년에 펌웨어 릴리스가 운영 메뉴를 바꿨습니다. 매뉴얼의 약 9페이지가 틀어졌죠.

이 9페이지를 업데이트하려면 문서를 다시 발행해야 했고, 문서를 다시 발행하면 적합성 선언이 같은 파일에 묶여 있었기 때문에 전체 준수 검토가 촉발되었습니다. 그 검토는 11주가 걸렸습니다.

그 11주 동안, 운영 섹션이 해당 기계와 맞지 않는 매뉴얼이 포함된 약 340대의 기계가 출고되었습니다. 메뉴 관련 서비스 콜은 한 달에 약 4건에서 약 30건으로 늘었고, 두 분기 동안 그 수준을 유지했습니다. 이는 대략 1인당 85파운드인 약 160건의 피할 수 있는 콜에 해당하며, 출시 작업에 미친 영향은 아직 계산하지 않은 금액입니다. 14,000파운드 미만이죠.

매뉴얼의 어떤 부분도 형편없이 작성된 것은 아니었습니다. 문서는 정확했고, 철저했으며, 제작도 잘 되어 있었습니다. 다만 저렴하게 변경할 수 없었고, 저렴하게 변경할 수 없는 문서는 대부분의 수명 동안 틀릴 수밖에 없습니다.

해결책은 구조적이었습니다. 승인 주체별로 4개의 문서로 분리했습니다. 준수 아래의 설치 및 안전, 제품 아래의 운영 가이드, 서비스 팀 아래의 서비스 및 문제 해결, 공급망 및 법무 아래의 부품과 보증. 이들 사이의 교차 참조와 네 가지 모두를 나열한 단일 커버 시트를 추가했습니다.

다음 펌웨어 릴리스에서는 운영 가이드를 4일 만에 업데이트하고 다시 발행했습니다. 준수 문서는 건드리지 않았습니다. 그 문서에는 바뀐 것이 없었기 때문입니다.

사람들이 실제로 열어 보는 매뉴얼을 작성하는 방법

먼저 목차 페이지를 작성하고, 매뉴얼을 실제로 사용할 사람에게 보여 주세요. 그 대화에서 구조적인 실수의 절반이 드러납니다. 어떤 글도 그 실수에 낭비되기 전에요.

논리적으로 먼저 나오는 섹션이 아니라, 독자가 가장 먼저 필요로 할 가능성이 높은 섹션부터 작성하세요. 대부분의 매뉴얼에서 이 둘은 다르고, 제품의 아키텍처를 따르는 순서는 거의 절대 독자의 문제를 따르는 순서가 아닙니다.

제목에는 독자의 표현을 사용하세요. 사람들은 자신에게 일어나는 상황을 기준으로 매뉴얼을 찾지, 그 상황을 담당하는 하위 시스템의 이름을 기준으로 찾지 않습니다.

순서가 정말로 중요한 경우에만 단계 번호를 매기세요. 번호 목록은 순서를 암시하며, 독자는 순서가 틀려도 암시된 순서를 따라갑니다.

모든 경고는 적용되는 단계 바로 앞에 배치하세요. 앞부분에 경고 챕터를 두는 것은 법적 산물이지 지침이 아닙니다. 한 번 읽고 끝이며, 다시 읽지 않습니다.

한 사람이 도움 없이 사용하는 모습을 보며 테스트하세요. 망설임 하나하나가 결함입니다. 이 작업은 40분이 걸리며, 세 번 이상의 검토 라운드를 찾아냅니다.

매뉴얼 템플릿에 무엇이 포함되어야 할까요?

최소한: 무엇을 다루는지, 대상이 누구인지, 오너와 승인자, 날짜가 포함된 버전, 독자의 상황에 맞게 구조화된 본문, 그리고 매뉴얼이 질문에 답하지 못할 때 사용할 이름이 있는 경로가 필요합니다.

그 외의 모든 것은 유형별로 달라집니다. 소프트웨어 사용자 매뉴얼은 스크린샷과 검색 친화적인 구조가 필요합니다. 운영 매뉴얼은 경고를 인라인으로 배치하고, 유지보수 일정과 적합성 정보를 담아야 합니다. 교육 매뉴얼은 목표와, 독자가 이해했는지 확인하는 방법이 필요하며, 다른 문서에는 전혀 필요하지 않을 수 있습니다.

사람들이 빼먹는 필드이자, 빼면 안 되는 필드는 승인자의 이름입니다. 이 페이지 전체가 그 이유를 설명하고 있으니까요.

소프트웨어 및 웹 애플리케이션 사용자 매뉴얼 템플릿

소프트웨어 매뉴얼에는 다른 문서에는 없는 한 가지 특성이 있습니다. 문서 아래에서 제품이 지속적으로 바뀐다는 점입니다. 그래서 무엇을 쓰든, 출시되는 날부터 문서가 낡아가기 시작합니다.

그렇다면 세 가지가 필요합니다. 첫째, 메뉴가 아니라 작업(task) 기준으로 구조를 잡으세요. 메뉴는 재구성되지만 작업은 그렇지 않기 때문입니다. 둘째, 각 주제를 업데이트할 수 있을 만큼 짧게 유지하세요. 즉, 묶인 문서가 아니라 검색 가능한 기사(문서) 묶음이 되어야 합니다. 셋째, 자주 바뀌는 것은 스크린샷으로 찍지 말고, 컨트롤이 어디에 있는지 보여 주는 대신 컨트롤 이름을 명시하세요.

특히 웹 애플리케이션의 경우, 매뉴얼은 대부분 인-프로덕트 도움말과 검색 가능한 헬프 센터로 대체되었고, 다운로드 가능한 PDF로 취급하는 것은 대개 실수입니다. 그 구조는 지식 베이스 아티클 템플릿에 이미 반영되어 있으며, 매뉴얼 템플릿이 해결하기 어려운 버전 관리 문제를 더 잘 처리합니다.

조달, 접근성 준수 또는 ‘하나를 요청하는’ 엔터프라이즈 고객처럼 정말 단일 문서가 필요한 경우에는, 별도로 유지보수하지 말고 아티클에서 생성하세요.

교육 매뉴얼 템플릿과 사용자 매뉴얼과의 차이

교육 매뉴얼은 한 번 읽습니다. 순서대로, 작업과는 떨어진 곳에서, 아직 그 일을 할 수 없는 사람이 읽습니다. 사용자 매뉴얼은 작업이 일어나는 지점에서, 대부분 할 수 있는 사람이 필요한 순간에 찾아봅니다.

이 한 가지 차이가 거의 모든 것을 바꿉니다. 교육 매뉴얼은 맥락, 풀어쓴 예시, 그리고 이해를 확인하는 방법이 필요합니다. 사용자 매뉴얼은 찾기 쉬움과 간결함이 필요하며, 그 안의 맥락은 잡음이 됩니다.

실무적으로는 교육 매뉴얼을 사용자 매뉴얼에 도입부를 추가해서 만들 수 없습니다. 대부분의 시도가 바로 그 방식인데, 그건 통하지 않습니다. 사용자 매뉴얼을 먼저 작성한 다음, 그 주변에 교육 매뉴얼을 작성하세요. 반복해서 쓰기보다 바깥으로 참조하는 방식으로요.

저희의 고객 서비스 교육 매뉴얼 템플릿은 한 기능에 대해 교육 측면을 자세히 다루며, 동일한 구조가 다른 기능에도 맞게 적용됩니다.

장비 및 규제 대상 작업을 위한 운영 매뉴얼 템플릿

운영 매뉴얼은 다른 문서와 달리 무게가 있습니다. 장비가 기계, 압력, 전기 또는 의료기기 규정의 적용을 받는 경우, 매뉴얼은 그 장비에 대한 문서가 아니라 제품의 준수(compliance) 일부입니다. 콘텐츠, 언어, 보관(유지) 방식, 그리고 포함되는 적합성 정보까지 모두 지정될 수 있습니다.

시작하기 전에 알아두면 좋은 실무적 결과가 있습니다. 매뉴얼은 보통 사용 국가의 언어로 제공되어야 하므로, 번역은 ‘있으면 좋은 것’이 아니라 준수(compliance) 질문이 됩니다. 경고는 해당 단계와 함께 있어야 하며, 표현 방식이 정해져 있을 수도 있습니다. 어떤 버전이 어떤 일련번호(serial number)와 함께 출고되었는지에 대한 기록은 수년간 보관해야 할 수도 있습니다. 그리고 장비에 대한 어떤 수정이든 매뉴얼을 다시 발행하고 재평가해야 할 수 있습니다.

이 모든 내용은 법률 자문이 아니며, 요구 사항은 관할권과 제품 유형에 따라 달라집니다. 게시하기 전에 준수 기능 담당자 또는 외부 전문가에게 적용 범위를 확인받고, 준수 승인된 콘텐츠는 별도의 문서로 유지하세요. 그래야 일반적인 운영 변경이 검토를 다시 끌고 가지 않습니다.

Word, Canva 또는 Google Docs에서 매뉴얼 템플릿을 받을 수 있나요?

Word는 인쇄하거나 PDF로 발송할 긴 형식의 매뉴얼에 적합합니다. Word는 번호가 매겨진 섹션, 교차 참조, 생성된 목차 페이지를 처리할 수 있는데, 이 세 가지가 30페이지를 넘어서면 가장 고통스러워지는 요소이기 때문입니다.

Google Docs는 협업으로 작성하고 온라인에서 읽는 매뉴얼에 적합하며, 코멘트 스레드는 검토 과정에서 실제로 유용합니다. 다만 길어지면 다루기 어려워지므로, 200페이지짜리 운영 매뉴얼보다는 교육 매뉴얼과 짧은 사용자 가이드에 더 잘 맞습니다.

Canva는 외형이 의미의 일부를 차지하는 매뉴얼에 적합합니다. 빠른 시작 가이드, 단일 시트 운영 지침, 벽에 붙일 만한 어떤 것이든요. 교차 참조가 100개나 들어가는 문서에는 잘못된 도구입니다.

선호가 아니라 길이와 목적지(사용처)에 따라 선택하세요. 그리고 무엇을 선택하든, 승인자가 서명할 수 있는 곳에 준수 승인된 콘텐츠를 유지하세요. 보통 그 위치는 나머지와 동일하지 않습니다.

재작성 프로젝트 없이 매뉴얼을 최신 상태로 유지하는 방법

문서를 분리하면 승인 문제를 해결할 수 있습니다. 하지만 글쓰기 문제는 해결되지 않습니다. 매뉴얼을 업데이트한다는 것은 누군가가 이미 알고 있는 단계를 스크린샷으로 찍고, 잘라내고, 다시 쓰는 작업을 의미하며, 그 작업은 절대 긴급한 일에 이기지 못합니다.

Trupeer AI는 그 비용의 대부분을 제거합니다. 현재 프로세스를 아는 사람이 한 번만 직접 기록하면, 결과물은 이미 단계와 이미지가 배치된 포맷된 매뉴얼 섹션으로 제공되어 ‘쓰기’가 아니라 ‘편집’할 준비가 됩니다. 아홉 페이지짜리 운영 변경이 오후 한때로 줄어듭니다.

기록하세요. 브랜드를 입히세요. 번역하세요. Trupeer하세요.

매뉴얼 크리에이터는 바로 이런 작업을 위해 만들어졌으며, 동일한 기록으로 교육용 영상과, 일관된 브랜딩의 지식 베이스용 문서를 생성할 수 있습니다. 번역은 대부분의 문서보다 여기서 더 중요합니다. 국경을 넘어 판매되는 장비의 경우, 현지 언어 버전이 종종 ‘예의’가 아니라 ‘요구 사항’이기 때문입니다. 설정 지침은 문서 템플릿 설정 가이드에 있습니다.

자주 묻는 질문

무료로 Word에 단계별 사용자 가이드 템플릿이 있나요?

위의 전면(프론트 매터) 구조는 Word에 그대로 붙여 넣을 수 있으며, 어떤 매뉴얼 유형이든 ‘하우스 셸(외피)’처럼 사용할 수 있습니다. 단계별 가이드의 본문은 각 단계를 하나의 행동과 그에 따른 예상 결과로 유지하고, 두 번째 주제로 분리하기 전 약 9단계 정도에서 멈추세요. 잠금 해제 다운로드도 없고, 양식도 없습니다.

무료로 Word에 교육 매뉴얼 템플릿이 있나요?

같은 전면(프론트 매터)을 사용한 다음, 본문은 제품의 기능이 아니라 독자가 할 수 있게 될 내용을 중심으로 구성하세요. 목표 → 풀어쓴 예시 → 연습 → 확인. Word는 교육 매뉴얼이 보통 순서대로 읽히고 종종 인쇄되기 때문에 이 방식에 잘 맞습니다.

Canva용 사용자 매뉴얼 템플릿이 있나요?

Canva는 짧은 시각형 매뉴얼에 잘 맞습니다. 빠른 시작 시트, 단일 페이지 운영 지침, 무엇이든 벽에 붙여둘 수 있는 형태라면요. 이 페이지의 전면 필드를 가져와 그곳에 배치하세요. 목차 페이지나 교차 참조가 필요할 만큼 긴 문서라면 Word 또는 Google Docs를 사용하세요.

Google Docs용 사용자 매뉴얼 템플릿이 있나요?

위의 구조를 Google 문서에 복사해 템플릿으로 팀 드라이브에 저장하세요. 협업 초안 작성과 온라인 읽기에 적합하며, 검토 코멘트는 실제로 큰 장점입니다. 문서가 매우 길어지면 Docs가 느리고 다루기 어려워지니 길이를 잘 관리하세요.

매뉴얼, 가이드, SOP의 차이는 무엇인가요?

매뉴얼은 포괄적이며 전체 제품 또는 작업을 다룹니다. 가이드는 한 가지 작업을 처음부터 끝까지 다룹니다. SOP는 조직이 무언가를 수행하는 방식에 대한 권위 있는 절차로, 독자가 학습하는 목적이 아니라 내부 준수를 위해 작성됩니다. 매뉴얼에는 종종 가이드가 포함되기도 합니다. SOP는 내부에 들어가는 것이 아니라 곁에 두는 형태입니다. 승인자가 다르기 때문이죠.

매뉴얼은 얼마나 길어야 하나요?

그 유형이 요구하는 만큼이면 됩니다. 하지만 그건 유용한 답이 아니니, 더 나은 기준을 제시하겠습니다. 일주일 안에 업데이트할 수 없는 매뉴얼은 너무 깁니다. 업데이트되지 않기 때문입니다. 보통은 콘텐츠를 줄이기보다 분리해야 한다는 신호입니다.

매뉴얼은 누가 작성해야 하나요?

작업을 하는 사람이 작성하고, 문서를 소유한 사람이 편집해야 합니다. 인터뷰를 바탕으로 문서화 기능만으로 완전히 작성된 매뉴얼은 대체로 구조는 잘 잡혀 있지만 세부 사항에서 미묘하게 틀리는 경우가 많습니다. 반대로 실무자가 전부 작성한 매뉴얼은 정확하지만 사용하기 어렵거나 활용이 불가능한 경우가 많습니다. 이 둘의 조합이 효과가 있습니다.

매뉴얼은 얼마나 자주 검토해야 하나요?

일정표가 아니라 트리거에 따라 검토하세요. 설명하는 대상이 바뀔 때, 지원 또는 서비스 패턴이 매뉴얼이 실패하고 있음을 시사할 때, 규정이 바뀔 때, 그리고 소유자가 떠날 때입니다. 캘린더 기반 검토는 아무것도 바뀌지 않았을 때 도착해, 무언가가 바뀐 순간을 놓치게 됩니다.