내부 설명서를 잘 만드는 방법

내부 설명서는 내부 팀원이 참조할 수 있도록 프로세스 및 절차를 명확하고 상세하게 작성하고 유지 관리하는 관행입니다.

내부 설명서는 이름에서 알 수 있듯이 고객에게 제공하는 매뉴얼과 같이 조직 외부 사용자가 이용하는 외부 설명서와는 다릅니다.

개발 및 IT와 관련하여 많이 이야기하기 때문에 내부 설명서가 다소 혼란스러울 수 있다는 것은 쉽게 알 수 있습니다. 이런 팀은 만드는 소프트웨어 및 애플리케이션에 대한 코드를 신중하게 문서화해야 합니다.

그러나 설명서는 다소 기술적인 측면이 있을 수 있지만 인적 리소스부터 고객 지원 팀에 이르기까지 회사 전체에 유용한 관행입니다.

이 문서에서 다룰 내용은 대체로 프로세스 설명서와 관련이 있습니다. 즉 팀원이 담당하는 일상적인 작업의 단계를 기록하는 것입니다.

그러나 이것 외에도 내부 설명서의 유형이 있습니다. 다른 일반적인 유형은 다음과 같습니다.

• 팀 설명서: 팀에서 수행 중인 작업과 관련 있는 정보입니다. 목표, 프로젝트 계획, 팀 일정, 상태 보고서, 미팅 메모 등을 예로 들 수 있습니다.
• 참조 설명서: 프로세스 설명서는 이 광범위한 유형에 포함됩니다. 참조 설명서는 사용자에게 중요한 주제, 프로세스 및 정책(예: 휴가 요청 방법)에 대해 교육합니다.
• 프로젝트 설명서: 특정 프로젝트에만 해당하는 설명서 유형입니다. 여기에는 제안, 제품 요구 사항, 설계 가이드라인, 스케치, 로드맵과 같은 내용이 포함될 수 있습니다.

이 문서에서는 주로 참조 설명서(특히 프로세스 설명서)를 중점적으로 다루지만, 다른 유형을 알고 있는 것도 도움이 됩니다.

너무 많은 기업이 위기가 눈앞에 닥치기 전에는 내부 설명서의 영향력을 인식하지 못합니다. 실제로 BPTrends 설문 조사에 따르면 항상 프로세스를 문서화하는 기업은 단 4%에 불과합니다. 또 다른 50%의 기업은 가끔씩 문서화한다고 합니다.

저희가 꼭 당부하고 싶은 것은 이런 통계의 일부분이 되지 않는 것입니다. 내부 설명서는 여러 가지 이유로 매우 중요합니다.

고객에게 월간 요약을 보내는 동료의 임무를 인수받았다고 가정하겠습니다. 혼자 알아내려고 시도하는 것이 더 빠르게 작업할 수 있을까요? 아니면 정보를 가져오고 배포하는 방법을 정확히 알려주는 자세한 안내와 스크린샷을 따르는 것이 더 빠를까요?

분명히 후자가 더 빠를 것입니다.

내부 설명서는 경비 보고서를 작성하거나 고객과 회의를 예약하는 등 팀원이 작업을 효율적으로 수행하기 위해 사용할 수 있는 공통 프로세스의 리소스 역할을 합니다. 스트레스가 적은 것은 말할 것도 없고 수많은 추측으로만 헤쳐나가는 것보다 훨씬 낫습니다.

Gallup의 조사에 따르면 직원 중 12%만 신규 직원 온보딩에 조직이 큰 역할을 한다는 데 매우 동의합니다.

당황스러운 결과입니다. 새로운 직장에 들어갔는데 스스로 모든 것을 헤쳐 나가야 한다고 느끼는 것은 최악이라고 할 수 있기 때문입니다.

강력한 내부 설명서 관행은 새로운 역할의 다양한 측면을 자신 있게 감당하기 위해 활용할 수 있는 공유 지식을 새로운 팀원에게 제공합니다.

물론 예민한 온보딩 기간에 멘토링 및 대면 상담과 같은 것을 설명서가 대체할 수는 없습니다. 하지만 설명서는 분명히 유용한 보충 자료이며 새로운 팀원에게 자율성과 독립성을 즉시 부여할 수 있는 좋은 방법입니다.

중요한 정보 및 전문 지식이 팀원 개개인의 머릿속에만 있는 경우가 너무 많습니다. 그런 경우 그 팀원들이 자리를 비울 때 큰 문제에 직면합니다. 한 설문 조사에서 응답자의 42%가 직장에서 필요한 지식이 고유하다고 인정했기 때문에 더 큰 문제가 됩니다.

따라서 이 내부 지식을 팀원의 머릿속에만 두지 말고 문서화하는 것이 일반적이어야 합니다. 이렇게 하면 사일로를 없애고 지식 공유를 촉진하고 예상치 못한 변화와 결원 중에도 팀이 더 수월하게 성공할 수 있습니다.

이유를 알았으면 이제 그 방법을 알아보겠습니다.

이 모범 사례를 따라 팀에 더 큰 혼란을 주지 않고 실제로 도움이 되는 내부 설명서를 만드세요.

설명서 내용를 이해기 위해 사전이 필요하다고 느낀다면 아무도 그 설명서를 보지 않을 것입니다. 단순하게 표현하고 전문 용어, 약어 또는 복잡한 표현을 너무 많이 사용하지 마세요. 또한 섹션 머리글 및 글머리 기호를 충분히 사용하여 부담스럽지 않게 문서를 훑어볼 수 있도록 만드세요.

일부 예제 및 시각 자료처럼 내용을 더 명확하게 하는 것은 없으므로 텍스트에만 의존하지 말고 적절하게 섞습니다. 연례 오찬 초대의 메일 병합을 완료하는 방법을 설명하는 대신 지난 번 스크린샷으로 프로세스 전체를 보여줍니다.

사용자가 설명서를 사용하기 원한다면 사용자가 찾을 수 있어야 합니다. 내부 설명서는 액세스할 수 있어야 하며 폴더 수십 개에 파묻히지 않아야 합니다. 이것이 바로 Confluence의 장점입니다. Confluence는 열린 페이지 트리 구조를 사용하므로 끝없는 폴더 레이어에 문서가 묻히지 않습니다. 파일 이름을 지정할 때 팀원이 설명을 찾기 위해 어떤 용어를 사용할지 생각해 보세요. 평범하고 직설적인 용어를 사용하면 팀원이 필요한 문서를 훨씬 더 쉽게 찾을 수 있습니다.

프로세스를 상세히 잘 알고 있으면 단계를 건너뛰고 중요한 세부 사항을 넘어가기 쉽습니다. 확실하지 않은 경우 많은 세부 정보를 제공하는 데 집중하세요. 그런 다음 프로세스에 익숙하지 않은 사용자에게 문서를 검토하고 단계를 따를 수 있는지 질문하여 직접 확인하세요. 사용자가 단계를 수행하는 데 어려움이 있다면 집중할 영역과 그 영역을 더 명확하게 만들 수 있는 방법을 생각해보세요.

위에 있는 팁으로 단서를 얻을 수 없었다면 내부 설명서를 직접 다룰 필요가 없습니다. 팀원들에게 회사의 아이디어를 한 페이지에 옮기고 각 팀원의 공통 프로세스 중 일부를 문서화하도록 요청하세요. 이 작업에 가장 익숙한 것은 결국 팀원들입니다.

회사와 팀 내에서 상황은 빠르게 바뀝니다. 무언가를 기록한다고 해서 그 내용이 그대로 확정되는 것은 아닙니다. 프로세스가 변경될 때(예: 새 소프트웨어를 사용하거나 일부 단계를 간소화한 경우) PDF 또는 기타 정적 리소스를 수정하거나 다시 만드는 것은 좋은 방법이 아닙니다. 업데이트 가능한 문서를 사용하면(Confluence가 여기에 매우 적합합니다!) 팀이 성장하면서 내부 설명서도 더 쉽게 변화할 수 있습니다. 팀원이 훨씬 더 쉽게 기여할 수 있다는 점도 추가적인 이점입니다.

정교한 내부 설명서 프로세스(템플릿 포함)로 설명서 작업을 훨씬 줄이고 전사적으로 일관성을 높일 수 있습니다. 자신의 프로세스를 만드는 프로세스가 있으며 Atlassian에서 이 부분을 도와드리겠습니다. 다음 단계를 따르세요.

Atlassian이 설명서를 매우 선호하지만 그렇다고 모든 정보를 꼼꼼하고 상세하게 기록해야 한다는 뜻은 아닙니다. 일회성 또는 무작위 이벤트에 대한 절차를 과도하게 엔지니어링할 필요는 없습니다.

먼저 문서화할 항목에 대한 몇 가지 기본 규칙을 설정합니다. 프로세스가 문서화할 가치가 있다고 판단하려면 특정 횟수(예: 3회)만큼 발생해야 합니까? 자주(예: 월 1회 이상) 프로세스를 수행해야 합니까?

모든 것을 문서화할 의도로 시작하는 것은 다소 바램이 지나친 것이며 작업하면서 숨이 막힐 수 있습니다. 그렇기 때문에 문서화할 가치가 있는 항목에 대한 몇 가지 기준을 설정하는 것이 좋습니다.

모두가 사용할 수 있는 템플릿 만들면 시간을 절약하고 설명서의 일관성을 유지할 수 있습니다. 템플릿에 다음 필드가 포함되는지 확인합니다.

• 이 프로세스가 존재하는 이유에 대한 간략한 설명
• 이 프로세스의 핵심 담당자
• 프로세스를 완료하는 데 필요한 항목(예: 소프트웨어 또는 소모품)

이런 필드로 해당 문서를 쉽게 따르는 데 필요한 정보를 갖고 있는지 확인합니다.

설명서를 사용하려면 설명서에 액세스할 수 있어야 합니다. 아직 만들지 않았다면 이 모든 기록을 저장할 수 있는 폴더 또는 허브를 만듭니다.

직원이 필요한 것을 힘들게 찾지 않도록 사용하는 모든 정보를 쉽게 검색할 수 있는 것이 이상적입니다.

정교한 문서화 프로세스가 마련되어 있어도 내용이 복잡해질 수 있습니다. 문서가 잘못된 위치에 저장되거나 단계를 업데이트해야 하는 경우가 있습니다.

월별 또는 분기별로 시간을 내어 모든 설명서를 확인하고 정리하세요. 이것은 프로세스를 수정하거나 파일을 구성하는 것을 의미합니다. 이렇게 하면 시스템을 최상의 상태로 유지할 수 있으며 결과적으로 활용성이 높아집니다.

내부 설명서를 위한 프로세스를 만드는 방법의 핵심 세부 정보를 알아보려면 이 가이드를 확인하세요.

내부 설명서를 작성하는 데 팀의 작업도 큰 도움이 되지만, 기술력이 더해지면 더 쉽게 작업할 수 있습니다. 개인의 데스크톱에 저장하는 파일 시스템이 아닌 내부 문서화 소프트웨어를 선택하세요. 소프트웨어를 사용하면 페이지를 공동으로 편집하고 인라인 및 페이지 댓글을 사용하여 피드백을 수집하고 다른 팀원이 입력할 수 있도록 태그를 지정할 수 있으므로 원활하게 기여할 수 있습니다.

또한 소프트웨어를 통해 관련 페이지를 전용 공간 및 고급 검색 기능과 함께 그룹화하여 체계적인 지식 허브를 만들 수도 있습니다. 그 결과는 팀 전체가 신뢰할 수 있는 체계적인 리소스가 됩니다.

큰 도움이 될 것으로 생각됩니까? Atlassian도 그렇게 생각합니다. Confluence를 확인하여 일관성을 보장하고 스트레스를 줄이는 내부 설명서를 작성하세요.

내부 설명서를 불필요한 형식적인 일로 간주하기 쉽지만 스스로 다시 물어보세요. 중요한 직원이 오늘 사직서를 제출하면 어떻게 될까요? 얼마나 귀중한 지식과 경험을 잃게 될까요?

몇 가지 문서화 관행을 확실하게 구현하면 여러분과 팀은 긍정적 태도와 자신감을 가지고 예상치 못한 상황에 대처할 준비를 하는 것입니다!