내부 문서: 알아야 할 모든 것(팁 및 자습서)

비즈니스에 내부 문서가 필요합니까? 그리고 처음에 내부 문서란 무엇입니까?

고객이 제품이나 서비스에서 더 많은 가치를 얻을 수 있도록 문서를 작성한다는 아이디어에 익숙할 수도 있지만 고품질 문서는 비즈니스와 직원의 업무 효율을 높이는 데도 도움이 됩니다.

이러한 유형의 내부 문서를 내부 문서라고 하며 이를 사용하여 생산성을 높이고 지식을 보존 및 공유하는 등의 작업을 수행할 수 있습니다.

이 가이드에서는 다음을 포함하여 내부 문서에 대해 알아야 할 모든 것을 배울 것입니다.

• 내부 문서란
• 내부 문서의 이점
• 내부 문서 모범 사례
• 자체 내부 문서 허브를 만드는 방법

내부 문서란 무엇입니까?

내부 문서는 회사의 절차, 지식, 모범 사례 등의 구조화된 모음입니다.

회사의 수명 동안 회사는 수많은 지식과 전문 지식을 축적할 것입니다. 내부 문서는 이 모든 집합적 지식을 쉽게 액세스할 수 있는 하나의 허브에 보존하는 데 도움이 됩니다.

생산성 향상, 지식 손실 방지, 신입 직원 온보딩 등에 사용할 수 있습니다.

몇 가지 주요 개념을 분석해 보겠습니다.

내부 및 외부 문서

내부 및 외부 문서는 모두 프로세스 문서화, 작업 방법 설명, 주요 지식 공유 등의 동일한 목표를 제공합니다.

주요 차이점은 해당 문서의 대상 독자가 누구인지에 있습니다.

• 내부 문서 – 대상 고객은 회사 직원입니다.
• 외부 문서 – 대상 고객은 사용자, 고객, 클라이언트 등입니다.

기본적으로 – 고객 또는 일반적으로 외부인은 내부 문서를 절대 볼 수 없지만 직원은 작업을 완료하기 위해 내부 문서에 의존할 가능성이 높습니다.

다양한 유형의 내부 문서

위에서 약간 설명했지만 내부 문서에는 여러 유형이 있으며 각 문서는 특정 목표에 맞게 조정해야 합니다.

• 프로세스 문서화 – 특정 작업을 올바르게 수행하는 방법을 문서화하고 싶을 것입니다. 여기에는 체크리스트, 튜토리얼 등이 포함될 수 있습니다. 예를 들어 "새 내부 문서를 만드는 방법"에 대한 기사가 있을 수 있습니다.
• 프로젝트 문서화 – 각 프로젝트의 세부 사항과 진행 상황을 문서화하고 싶을 것입니다. 여기에는 제안, 비즈니스 사례, 회의 요약, 일정 등이 포함될 수 있습니다.
• 정책/HR 문서화 – 직원 온보딩, 휴가 정책, 병가, 직원 오프보딩 등과 같은 중요한 정책을 문서화해야 합니다.
• 팀 문서 – 각 팀은 팀별 지식 및 정책에 대한 자체 내부 문서를 작성할 수 있습니다. 예를 들어 콘텐츠 팀에서 게스트 포스터 작업을 위한 블로그 스타일 가이드 및 정책을 문서화할 수 있습니다.
• 기술 문서 – 개발 팀이 있는 경우 코드, 스타일 가이드, QA 테스트 정책 등에서 무슨 일이 일어나고 있는지 설명하는 자체 내부 문서를 만들고 싶어할 것입니다.

내부 문서화의 이점: 노력할 가치가 있는 이유는 무엇입니까?

내부 문서를 작성하는 것은 "그냥 날개를 대는 것"에 비해 의심할 여지 없이 약간의 추가 시간이 걸립니다.

내부 문서화의 이점은 무엇입니까? 즉, 내부 문서 작성에 시간과 노력을 투자할 가치가 있는 이유는 무엇입니까?

다음은 가장 큰 내부 문서 이점 중 일부입니다.

• 지식 공유 촉진 – 직원들이 지식을 공유하도록 장려할 수 있습니다. 또한 직원은 매번 원래 공유자와 직접 상호 작용할 필요 없이 다른 직원이 공유한 지식에 쉽게 액세스할 수 있습니다.
• 생산성 향상 – 중요한 프로세스와 세부 사항을 문서화하여 직원이 불필요하게 얽매이지 않도록 하여 전반적인 생산성을 높일 수 있습니다.
• 보다 효율적 으로 신입 사원을 온보딩하십시오. 신입 사원이 회사에 합류하면 통합된 내부 지식에 의존하여 빠르게 적응할 수 있습니다.
• 지식 보존 – 어느 시점에서 핵심 직원은 영구적으로 또는 휴가/질병으로 인해 떠나게 됩니다. 내부 문서가 있으면 해당 직원에 대한 지식이 여전히 보존되고 직원이 사라진 경우에도 액세스할 수 있습니다.

품질 내부 문서 작성을 위한 모범 사례

내부 문서가 무엇이고 왜 중요한지 알았으니 이제 내부 문서 허브를 실제로 만드는 방법에 대해 알아보도록 하겠습니다.

몇 가지 일반적인 내부 문서 모범 사례로 시작한 다음 고유한 허브를 만드는 기술 프로세스를 다룰 것입니다.

• 주요 이해 관계자 참여 - 내부 문서는 하향식 접근 방식을 사용해서는 안 됩니다. 각 수준에서 주요 직원을 참여시키는 것이 중요합니다. 결국, 이 직원들은 종종 당신이 보존하고 싶은 "참호" 지식을 가진 사람들입니다. 또한 명확한 의사 결정자가 있도록 특정 직원을 콘텐츠 큐레이터로 지정할 수도 있습니다.
• 기존 문서의 용도 를 변경하십시오. 이미 다양한 위치에 기존 콘텐츠를 집어넣었을 수 있으므로 전체 내부 문서를 처음부터 새로 작성할 필요가 없습니다. 해당 콘텐츠를 하나의 중앙 허브로 용도를 변경하여 더 쉽게 액세스할 수 있도록 하십시오.
• 쉽게 액세스할 수 있도록 만드십시오. 액세스 용이성이라고 하면 허브를 쉽게 탐색하고 검색할 수 있어야 합니다. 즉시 검색 제안과 같은 카테고리 및 기능을 사용하여 직원을 관련 콘텐츠로 안내하세요.
• 일관성을 위한 스타일 가이드를 만드 십시오. 모든 문서가 다른 형식을 사용한다면 사람들이 가치를 얻기 어려울 것입니다. 이를 방지하려면 미리 스타일 가이드를 만들고 콘텐츠의 각 부분에 대해 스타일 가이드를 따르세요.
• 텍스트에만 의존하지 말고 이미지, 비디오 및 GIF를 포함하세요. 이미지, 비디오 및 GIF 와 같은 기타 미디어를 포함하면 콘텐츠를 더욱 유용하게 만들 수 있습니다. 예를 들어, 특정 프로세스를 문서화할 때 프로세스를 문서화하는 이미지나 비디오를 포함할 수 있습니다.
• 과도한 문서화 방지 – 내부 문서화에는 많은 이점이 있지만 과도한 문서화는 직원을 좌절시키고 짜증나게 할 수도 있습니다. 중요한 세부 사항을 문서화하는 것과 바쁜 업무로 직원에게 부담을 주는 것 사이에서 균형을 유지하는 것이 중요합니다.
• 모든 것을 최신 상태로 유지 하십시오. 프로세스와 기관 지식은 시간이 지남에 따라 변경되므로 이러한 변경 사항에 보조를 맞추기 위해 내부 문서를 업데이트하는 것이 중요합니다. 다시 말하지만, 시간이 지남에 따라 내부 문서를 업데이트할 책임이 있는 이해 관계자로 직원을 지정하는 것이 도움이 될 수 있습니다.
• 직원들에게 피드백을 요청 하십시오. 내부 문서는 직원의 삶을 더 쉽게 만들기 위한 것임을 기억하십시오. 직원들이 내부 지식을 개선하는 방법에 대한 훌륭한 아이디어를 가지고 있을 수 있으므로 직원들에게 피드백을 요청하는 것을 두려워하지 마십시오.

내부 문서 허브를 만드는 방법

이제 마지막 질문입니다. 모든 직원이 내부 문서 리소스에 액세스할 수 있는 허브를 실제로 만드는 방법은 무엇입니까?

기술 자료 소프트웨어와 관련하여 세 가지 주요 옵션이 있습니다.

• WordPress 및 HeroThemes와 같은 오픈 소스 소프트웨어를 사용하십시오.
• SaaS 도구를 사용합니다.
• 자신의 솔루션을 코딩하십시오.

우리는 약간 편향되어 있을 수 있지만 WordPress를 사용한 오픈 소스 접근 방식은 다음과 같은 몇 가지 이유로 매우 합리적이라고 생각합니다.

• 귀하는 귀하의 문서에 대한 완전한 소유권과 통제권을 가 집니다. 문서에 다른 사람의 서버에 저장하고 싶지 않은 민감한 정보가 포함될 수 있습니다(SaaS 도구에서와 같이). WordPress를 사용하면 모든 데이터와 정보를 자체 서버에 보관할 수 있습니다.
• 그것은 여전히 ​​​​매우 간단 합니다. Heroic Knowledge Base와 같은 WordPress 플러그인을 사용하면 매우 짧은 시간에 시작하여 실행할 수 있습니다.
• 비용 효율적 입니다. WordPress 접근 방식은 일반적으로 SaaS 도구보다 훨씬 저렴합니다. 1년에 걸쳐 분할 상환하면 일반적으로 기사 무제한 및 사용자 무제한에 대해 월 $15 미만을 지불하게 됩니다.

WordPress와 Heroic Knowledge Base 플러그인을 사용하여 내부 문서 허브를 만드는 방법은 다음과 같습니다.

1. WordPress 설치 설정

시작하려면 내부 지식 허브 역할을 하는 새로운 WordPress 설치를 만들고 싶을 것입니다.

WordPress 설치에는 두 가지 옵션이 있습니다.

1. 회사의 로컬 네트워크에서만 액세스할 수 있는 인트라넷 사이트를 만들 수 있습니다. WordPress 인트라넷 사이트 설정에 대한 가이드가 있습니다.
2. 어디서나 액세스할 수 있는 공개 WordPress 사이트를 만들 수 있지만 직원의 비밀번호 및/또는 사용자 계정을 사용하여 액세스를 제한할 수 있습니다. 사용자 계정을 만들거나 직원과 공유할 수 있는 단일 암호로 전체 사이트를 제한할 수 있는 플러그인이 많이 있습니다.

요즘 원격 작업의 인기로 인해 직원이 사무실에 없을 때도 내부 문서에 액세스할 수 있도록 두 번째 접근 방식을 원할 것입니다.

2. 영웅 지식 기반 설치

WordPress를 설치했으면 Heroic Knowledge Base 플러그인을 추가하여 내부 문서 허브로 전환할 수 있습니다.

Heroic Knowledge Base는 WordPress에 전체 지식 기반 기능을 추가하는 WordPress 플러그인입니다. 여기에는 내부 문서 허브를 성공으로 이끄는 여러 기능이 포함되어 있습니다.

• 직원을 관련 콘텐츠로 안내하는 즉각적인 검색 제안.
• 주제, 부서 등으로 콘텐츠를 구성하는 무제한 카테고리
• 직원이 기사에 대한 피드백을 제공할 수 있도록 기본 제공 피드백 도구.
• WordPress의 내장 버전 관리 시스템을 통한 손쉬운 버전 관리 및 개정 관리. 시간이 지남에 따라 기사가 어떻게 변경되었는지 확인하는 데 유용합니다(필요한 경우 변경 사항 되돌리기).
• 직원이 가장 관심 있는 콘텐츠를 확인하는 내장 분석. 이 정보를 사용하여 문서를 수정하고 최적화할 수 있습니다.
• 도움말 도우미 위젯은 직원이 관련 문서를 쉽게 찾을 수 있는 또 다른 방법을 제공합니다.

Heroic Knowledge Base를 구매하면 다른 WordPress 플러그인처럼 설치할 수 있습니다. 그러면 내부 문서 지식 기반에 대한 모든 것을 구성할 수 있는 사용하기 쉬운 설정 영역이 표시됩니다.

또는 문서 허브의 디자인을 처리하는 동시에 Heroic Knowledge Base 플러그인의 모든 기능을 구축하는 KnowAll 테마를 사용할 수도 있습니다.

3. 문서 문서 추가

Heroic Knowledge Base 플러그인을 설치하고 나면 내부 콘텐츠를 추가할 준비가 된 것입니다.

Heroic Knowledge Base를 사용하면 유연한 WordPress 블록 편집기를 사용하여 이 작업을 수행할 수 있습니다.

Heroic Knowledge Base는 또한 문서를 향상시키는 데 도움이 되는 몇 가지 전용 블록을 추가합니다. 예를 들어 다음과 같은 주요 정보나 문제를 강조하기 위해 설명선이나 경고를 쉽게 추가할 수 있습니다.

또한 카테고리를 무제한으로 추가하여 콘텐츠를 구성할 수 있습니다.

기사 및/또는 카테고리의 순서를 변경하기 위해 특별한 드래그 앤 드롭 인터페이스가 제공됩니다. Heroic KB → Article Ordering 또는 Heroic KB → Category Ordering 으로 이동하여 액세스할 수 있습니다.

지금 내부 기술 자료를 만드십시오.

내부 문서를 작성하려면 콘텐츠 작성에 시간을 투자해야 하지만 지식을 보존 및 공유하고 생산성을 향상하며 보다 효율적으로 신입 사원을 온보딩할 수 있을 때 투자는 결실을 맺을 것입니다.

내부 문서 허브를 설정하는 가장 쉬운 방법으로 오픈 소스 WordPress 소프트웨어와 Heroic Knowledge Base 플러그인을 사용할 수 있습니다.

WordPress 및 Heroic Knowledge Base를 사용하면 다음과 같은 이점을 얻을 수 있습니다.

• 모든 것이 귀하의 서버에 있기 때문에 회사 데이터에 대한 완전한 소유권 및 제어.
• 무제한 사용에 대해 하나의 낮은 고정 비용을 지불하기 때문에 비용이 절감됩니다.
• Heroic Knowledge Base는 필요한 모든 기능을 제공하므로 사용자 정의 솔루션을 처음부터 코딩할 필요가 없기 때문에 단순합니다.

지금 내부 콘텐츠 허브를 설정하면 곧 혜택을 받을 수 있습니다.