이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- WordPress
- 기술 문서 작성자:
- dmivelli
- 프로젝트 이름:
- WordPress HelpHub의 기사 검색 가능성 개선 문서
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
핵심 요약
WordPress의 인기는 분 단위로 증가하고 있습니다. 2020년 7월 초 기준으로 WordPress 5.4 (2020년 3월 21일에 출시된 최신 버전)는 거의 5,100만 번 다운로드되었습니다. 가장 많이 사용되는 언어는 영어 (71%)이며 그다음으로 스페인어 (4.7%), 인도네시아어 (2.4%)가 사용됩니다.
우수한 기술 문서는 모든 지원 시스템의 핵심입니다. 경험 많은 기술 작가는 지식을 사용자를 위한 콘텐츠로 제작합니다. 사용자가 그때 그들에게 가치가 있거나 필요한 작업을 수행하려고 합니다. 훌륭한 테크니컬 라이터는 잘 작성되고 정확한 문서 그리고 사용자의 마음을 떠올릴 수 있는 능력이 필수적이라는 사실을 잘 알고 있습니다. 그러나 편집 및 제작 품질과 같이 기술 작가에게 가장 중요한 사항은 사용자에게 적시성 및 검색 가능성보다 덜 중요할 수 있습니다. 사용자가 찾을 수 없는 잘 작성된 도움말은 무슨 소용이 있을까요?
2003년 시작 이후, 오픈소스 분야에서 WordPress는 성장하면서 개발자, 사용자, 기여자의 관심을 끌었습니다. WordPress 커뮤니티의 성장과 변화하는 요구사항에 맞춰 원래 도움말 카테고리와 태그를 업데이트하고 현대화해야 합니다.
사용자가 요청한 문서로 이동하는 경로가 혼란스러워지거나 중단되는 경우 검색에 실패하고 제품에 대한 신뢰를 잃고 완전히 잃어버릴 수 있습니다.
해결 방법이 있습니다. 다음은 검색 가능성을 개선하고 사용자가 예상하는 문서로 이동하는 경로를 지원하는 방법입니다.
- 카테고리 제목 스타일 결정 및 설정
- 카테고리 제목을 평가하여 주제를 올바르게 다루고 있는지 확인합니다 (필요한 경우 업데이트 제안).
- 도움말을 검토하고 카테고리가 올바른지 확인하세요.
- 각 기사의 하위 카테고리 정의
- 검색 결과가 사용자를 지원 포럼으로 안내하지 않도록 합니다.
- 중복되거나 오래된 주제는 삭제할 수 있습니다.
WordPress 커뮤니티는 지난 17년간 놀라운 성과를 거두었으며 그 성과를 공유하고 있습니다. 분류를 업데이트하고 사용자 여정이 정확한지 확인하면 매달 거의 7천만 개의 새 게시물과 7, 700만 개의 새 댓글을 작성하는 사용자의 성장과 성공, 충성도에 도움이 될 것입니다.
소개
작가 조셉 캠벨이 영웅의 여정이라는 용어를 만들었습니다. 소설에서 주인공이 세계로 여행하고, 문제에 직면해 이를 극복하고, 결과를 변화시키는 구조적 개념을 가리킵니다.
기술 문서 영역에서도 사용자는 학습, 답변 확인, 문제 해결을 목표로 도움말 주제로 이동하는 여정을 시작합니다. 사용자가 이를 실행할 수 있으면 모든 것이 잘 돌아가는 것입니다. 사용자가 답변을 찾을 수 없으면 불만족스러워하며 떠납니다.
그런데, 이것이 왜 중요할까요? 작성자가 요령을 피하거나, 신경 쓰지 않거나, 노하우가 없기 때문이 아닙니다. 기술 문서 작성자가 사용자 여정을 고려하지 않은 경우가 많습니다. 작성자는 양질의 콘텐츠를 만드는 데 몰두할 수 있지만 사용자가 주제에 어떻게 접근할 것인지 고려하지 않습니다. 사용자 여정에 집중하는 것이 중요합니다. 사용자가 알고 싶어 하는 내용과 원하는 방식을 고려해야 합니다.
WordPress 컨설턴트와 UX 디자이너인 Estela Rueda와 이야기를 나눈 후 몇 가지 경력을 쌓았습니다. 현재 일부 제목이 기사 콘텐츠를 정확하게 설명하지 않습니다. 카테고리는 태그로 사용되며, 15년 전에 만들어졌기 때문에 오래된 카테고리도 있습니다. 태그가 일관되지 않습니다. 이로 인해 답변을 찾는 사용자에게 장애가 됩니다.
현재 상태
WordPress 지원은 9가지 주요 카테고리 (시작하기, WordPress 설치, 기본 사용, 기본 관리, 맞춤설정, 유지보수, 보안, 고급 주제, 문제 해결)로 나뉩니다. 각 카테고리에는 여러 하위 카테고리 또는 하위 주제가 포함되어 있으며, 각 방문 페이지에서 더 많은 하위 카테고리 또는 하위 주제가 표시될 수 있습니다.
WordPress에 열정적으로 협력하는 참여자가 있으면 다양한 주제를 다룰 수 있다는 이점이 있습니다. 그러나 다양한 의견과 관점이 존재하기 때문에 태그와 카테고리가 일관되지 않습니다.
이러한 주제는 카테고리가 WordPress 사용자의 현재 요구사항을 충족할 수 있도록 현대화해야 합니다. 200개가 넘는 도움말이 있으므로 태그 및 분류와 관련된 문제가 발생할 수 있습니다.
계획 분석
주요 목표는 검색 가능성을 개선하기 위해 도움말을 검토하고 재분류하는 것입니다. 다음 단계를 제안합니다.
Mentor Estela Rueda와 협력하여 프로세스 확고히 하기
- 세부정보를 확인하고 동의하는 데 중요한 단계입니다.
- 에스텔라에 따르면 제안된 모든 업데이트는 스프레드시트에서 추적합니다. 에스텔라의 경험에 따르면 먼저 의견을 수집한 다음 제안하는 것이 가장 좋다고 합니다.
카테고리 제목의 스타일 결정 및 설정
- 동명사 형식 (설치 vs. 설치 중) 대신 현재 시제의 카테고리 구조를 일관되게 사용하는 것이 좋습니다. 동명사 형식 (-ing)은 제2외국어 (ESL) 사용자에게 어려움을 줄 수 있으며 -ing은 사용자에게 가치를 더하지 않습니다.
- 일부 카테고리는 한 단어 또는 두 단어로 된 주제 (예: 유지보수, 보안, 기본 관리)이고 일부는 동명사 문구 (예: WordPress 시작하기, 맞춤설정)입니다. 구조를 일관되게 만드는 것이 좋습니다.
- 다른 조직에서 온라인 도움말을 어떻게 설정하는지 조사해 왔으며, 이에 대해 멘토와 논의하여 무엇이 유용할 수 있는지 알아보겠습니다.
카테고리 제목 평가 (및 업데이트 제안)
- WordPress 타겟층의 관점에서 인식할 수 있고 현재 니즈에 적합해야 합니다.
- 일관성이 있으며 WordPress 스타일 가이드 표준을 준수하는지 확인합니다.
- 제목에 의도를 전달하고 설명하는지 확인
- 제목은 필요한 기본 작업 또는 사용자/기기 상태를 명확하게 설명해야 합니다.
기사/주제 검토
- 주제가 WordPress 타겟층의 사용자 니즈를 정확하게 충족하나요?
- 주제가 올바른 맥락을 설정하나요? 아니면 더 큰 시퀀스의 일부인가요?
- 단계에서 작업의 다양한 행위자 (사용자, 시스템/기기, 누가 무엇을 하는지)를 구분하나요?
- 등장인물이 명확하게 구분되나요?
- 단계가 복잡한 프로세스를 실행 가능한 청크로 나누나요?
하위 카테고리 정의 및 태그 지정
- 사용자 스토리를 참고하고 나중에 참고할 수 있도록 스프레드시트에 계속 추가합니다.
- 하위 카테고리 목록에 계속 추가하고 경로를 자세히 설명합니다.
사용자가 지원 포럼으로 연결되는 검색 결과가 없어야 합니다.
중복되거나 오래된 주제를 확인하여 삭제합니다. 이러한 포렌식 작업은 사용자 여정을 파악하고 간소화하는 데 도움이 됩니다.
타임라인
2020년 8월 16일까지
- WordPress 문서 계속 검토
- WordPress 문서 스타일을 숙지합니다.
- 도움말 주제로 고객 여정에 대한 권장사항을 조사하세요.
8월 17일~9월 13일
- Estela 및 WordPress 커뮤니티 알아보기 및 협업하기
- 에스테라와 공동작업하여 프로젝트 단계를 수정하고 완료의 주요 기록을 제안합니다.
- 주요 일정 및 주간 작업을 포함하는 일정을 만듭니다.
- Estela와 상태 점검 주기를 설정하여 방해 요소가 있는 경우 시기적절하게 해결합니다.
9월 14일~11월 30일
- Estela/멘토와 함께 프로젝트 시작 및 개발 작업
12월 2~5일
- 최종 작업 제품 보고서 제출
12월 3~10일
- 프로젝트 성공 평가 및 WordPress 멘토 및 팀과의 협업 경험 평가 제출
결론
WordPress는 가장 널리 사용되는 콘텐츠 관리 시스템 (CMS)입니다. W3techs에 따르면 WordPress는 모든 웹사이트의 37.7% 에서 선택하는 CMS로, WordPress의 CMS 시장 점유율은 63.6% 입니다.
WordPress의 인기가 높아짐에 따라 WordPress 사용자의 마음을 사로잡으려면 정확하고 따라하기 쉬운 문서가 필수적입니다.
WordPress는 사용자 여정과 가능한 사용자 경로에 관한 질문을 고려하여 도움말 카테고리와 태그를 현대화하여 질문에 효과적으로 답변하고 문제를 해결할 수 있습니다. 이런 식으로 WordPress는 앞으로도 지속적으로 만족스러운 고객을 유치할 것입니다.