조직하다! 기술 자료 스타일 가이드를 만드는 방법

지식 기반을 작성하는 것은 이미 충분히 어렵습니다. 그래서 이 글에서 제가 하려는 일에 대해 사과드립니다. 지식 기반의 아이디어뿐만 아니라 아이디어를 제시 하는 방법 도 중요합니다.

이러한 아이디어 외에도 항상 다음을 수행해야 합니다.

• 적절한 톤 사용
• 일관되게 모든 것을 동일한 형식으로 지정

다음 섹션에서 설명할 이유 때문에 실제로는 놀라울 정도로 어렵습니다. 바로 지식 기반 스타일 가이드가 필요한 곳입니다.

지식 기반이 다양한 스타일의 엉망이 될 수 있는 이유

지식 기반이 다양한 스타일로 뒤죽박죽인 경우 너무 걱정하지 마십시오. 일반적으로 두 가지 이유 중 하나(또는 때로는 둘 다!)로 인해 수많은 회사에서 발생합니다.

첫째, 팀의 일원인 경우 지원 문서를 작성하는 다른 사람들이 있을 수 있습니다. 그래서 만약:

• Jim은 기사 A 를 작성합니다.
• Sally는 기사 B 를 작성합니다.

미리 정의된 스타일 가이드가 없는 한 해당 기사는 스타일과 형식이 크게 다를 수 있습니다.

이제, 당신이 팀의 일원이 아니라면, 아마도 "나는 외로운 늑대야. 나는 모든 것을 직접 쓰고 있다. 그래서 종이에 아무 것도 적을 필요가 없습니다. 그게 전부입니다!”

그리고 한 번에 모든 지식 기반 기사를 작성했다면 그럴 수도 있습니다.

하지만 우리 둘 다 그게 일반적으로 작동하는 방식이 아니라는 것을 알고 있습니다. 그렇죠? 제품을 처음 출시했을 때 많은 지식 기반 기사를 작성했을 것입니다.

하지만 3개월 후 새로운 기능을 출시합니다. 이제 그 새로운 기능에 대한 지식 기반 항목을 작성해야 하며... 인간의 기억력은 그리 좋지 않습니다 . 시도하지 않더라도 결국 다른 일을 하게 될 가능성이 높습니다.

따라서 솔로이든 팀의 일원이든 지식 기반 스타일 가이드를 종이에 적어두는 것이 좋습니다.

기업이 실제로 이것을 합니까? 지식 기반 스타일 가이드가 실제입니까?

자, 잠시 후에 스타일 가이드를 만드는 방법을 알려 드리겠습니다. 하지만 먼저, 실제로 이것을 하고 있는 몇 가지 회사의 예를 들고 싶습니다. 이렇게 하면 두 가지 목표를 달성할 수 있습니다.

• 더 많은 블로그 콘텐츠를 만들기 위해 꾸미고 있는 것이 아님을 보여줍니다.
• 자신만의 스타일 가이드로 활용할 수 있는 실제 사례를 제공합니다.

먼저 모질라를 살펴보자. Mozilla는 지식 기반에 대한 스타일 가이드에 대한 전체 항목을 가지고 있습니다. Mozilla는 오픈 소스이기 때문에 "Firefox 지원 지식 기반을 일관성 있게 만들어 지식 기반을 만들고 읽기 쉽고 기여할 수 있도록" 스타일 가이드를 갖는 것이 특히 중요합니다. 읽기 쉬운? 지식 기반을 위한 좋은 목표처럼 들립니까?

이 가이드는 대문자, 공백, 연속 쉼표에 이르기까지 모든 것을 자세히 설명합니다.

다음으로, MailChimp의 Voice & Tone은 또 다른 읽을 가치가 있습니다. 지식 기반에 100% 초점을 맞추는 것은 아니지만 지식 기반 및 자습서 콘텐츠 모두에 대한 항목이 많이 있습니다.

Mozilla의 스타일 가이드는 스타일과 서식에 더 중점을 둔 반면 MailChimp는 핵심 서식보다 음성과 어조에 더 중점을 둡니다.

기술 자료를 위한 스타일 가이드를 만드는 방법

몇 가지 예를 들었지만 실제로 지식 기반 스타일 가이드를 만드는 프로세스는 아직 제공하지 않았습니다. 그래서 그것을 수정하자!

일관된 사람을 사용하십시오

저자가 '나'와 '우리'를 왔다갔다 하는 기사를 본 적이 있나요? 나는 그것이 매우 혼란 스럽다고 말할 수 있습니다.

따라서 1인칭을 사용하려는 경우 하나를 선택하고 일관성을 유지하십시오. 솔로인 경우에도 "we"를 사용하도록 선택할 수 있습니다. 당신 한테 달렸습니다! 같은 것을 사용하면 됩니다.

또한 1인칭을 사용할 필요도 없습니다. "나"와 "우리"를 모두 생략하도록 선택할 수 있습니다.

여기에 정답은 없습니다. 단지 일관성에 관한 것입니다.

서식 표준화

최고의 지식 기반 문서 템플릿 가이드를 읽으면 좋은 지식 기반이 작은 단계로 많은 지침을 사용한다는 것을 알 수 있습니다. 그리고 이러한 지침에는 다음과 같은 언어가 포함될 것입니다.

파일 을 클릭합니다.

그래서 – 그것은:

• 파일 을 클릭하십시오
• "파일"을 클릭하십시오
• 파일 을 클릭하십시오

그리고 실제로 목록을 작성할 때는 다음과 같습니다.

• 1단계: 이것을 클릭하십시오
• 2단계: 클릭

아니면 다음과 같습니까?

• 이것을 클릭
• 클릭

다시 말하지만 가장 좋아하는 것을 선택할 수 있지만 어느 것을 선택하든 전체 지식 기반에서 일관되게 사용하십시오.

다른 형식 선택도 해야 합니다. Mozilla 스타일 가이드는 다루어야 할 모든 것에 대한 좋은 아이디어를 제공하지만 다음은 몇 가지 시작 아이디어입니다.

• 표제 대문자 사용 – 문장의 대소문자를 사용할 것입니까 아니면 제목의 대소문자를 사용할 것입니까?
• 숫자 – 10입니까 아니면 10입니까?
• 약어 – 하지 않거나 하지 않습니까?
• 약어 – CDN 또는 콘텐츠 전송 네트워크?

기술 자료 WordPress 테마 또는 플러그인 중 하나를 사용하는 경우 내장된 단축 코드 및 형식 지정 옵션을 사용하면 형식 지정과 관련하여 일관성을 유지할 수 있습니다.

올바른 목소리 얻기

마지막으로 형식화를 넘어 음성을 표준화해야 합니다.

당신은 고객의 친구입니까? 아니면 냉정하고 냉철한 지혜를 냉정하게 분배하는 Star Trek의 Spock입니까?

이유는 어느 쪽이든 괜찮습니다. 일관성이 있는 한.

일반적으로 MailChimp의 지식 기반 가이드 팁을 따라야 합니다. MailChimp가 실제로 가이드를 게시했기 때문에 뿐만 아니라 MailChimp가 최고의 지식 기반 중 하나를 보유하고 있다고 생각하기 때문에 추천합니다.

그들의 조언은 이렇습니다.

• 항상 질문에 답하고 독자들에게 정보를 제공하는 것을 최우선으로 하십시오. 농담은 때때로 괜찮지만 그 본질적인 목표에서 주의를 산만하게 하는 경우에는 그렇지 않습니다.
• 마케터처럼 말하는 것을 피하십시오. 단지 도움을 주려는 것일 뿐입니다.

스타일 가이드를 어디에 보관해야 하나요?

이러한 결정 만 해서는 안 됩니다. 또한 실제로 안전한 장소에 기록해야 합니다.

개인적으로 작업하는 대부분의 스타일 가이드는 Google 문서 문서입니다. 이렇게 하면 스타일 가이드를 쉽게 공유하고 다른 컴퓨터에서 액세스할 수 있습니다.

그러나 다른 방법을 선호하는 경우 익숙한 방법을 사용하십시오. 정말 중요한 것은 이것뿐입니다.

기술 자료 형식 지정 방법에 대한 복습이 필요할 때 귀하 또는 다른 사람이 액세스할 수 있는 안전한 장소에 지식 자료 스타일 가이드 사본이 저장되어 있습니다.

따라서 종이에 적어두고보다 일관된 지식 기반 기사를 작성하십시오!