WordPress를 사용하여 도움말 작성 도구를 빌드하는 방법

게시 됨: 2022-04-28

훌륭한 기술 작성자는 신뢰할 수 있는 HAT(도움말 작성 도구)에서 멀리 떨어져 있지 않습니다.

기술 작문 업계의 핵심 도구인 도움말 작성 도구는 '복잡한 것을 단순하게 만드는' 기술을 변형하고 변형합니다.

HAT는 기술 작성자를 위한 생산성 극대화 장치입니다. 10x 기술 작가는 게임의 이러한 측면을 확고하게 설정했습니다.

목적에 완벽하게 들어맞도록 사본을 형성하고 편집하는 반복적인 단계가 너무 많습니다...

...당신은 당신과 함께 일하고 최고의 문학 제품을 공식화하는 데 모든 노력을 집중할 수 있도록 도와줄 HAT가 정말로 필요합니다.

HAT의 개념은 새로운 것이 아닙니다.

그들은 주변에 있었다.

그리고 어떤 사람들은 가족 사진이라면 약간 귀가 멍해지고 세피아 색이 되고 관련성이 없어졌을 수도 있다고 말할 수도 있습니다.

예를 들어, 많은 경우에 WYSIWYG 편집기를 소유하는 것은 프리미엄 기능으로 간주됩니다.

그러나 좀 더 측면에서 생각해보면 콘텐츠 관리 시스템(CMS)의 다용성과 다면적 양도 가능한 이점을 적용하여 21세기에 HAT를 출시할 수 있는 사례가 있습니까?

우리는 WordPress CMS의 경우 – 세계 최고의 웹 구축 플랫폼이자 컨트리 마일 단위로 가장 인기 있는 CMS 소프트웨어…

… 대답은 다음과 같습니다. 예.

그러나 우리의 말을 그대로 받아들이지 마십시오. 다음 몇 분간 시간을 내어 워드프레스 CMS가 슬라이스 빵 에스프레소 커피 이후 테크니컬 라이터에게 일어날 수 있는 차선책인 이유에 대해 좀 더 자세히 알아보십시오.

여기, WordPress를 사용하여 도움말 작성 도구를 구축하기 위한 HeroThemes 가이드입니다.

오늘날 테크니컬 라이터의 일반적인 요구 사항

오늘날 테크니컬 라이팅은 많은 전문 주제에 걸쳐 있습니다.

  • 정부 공공 정책
  • IT 컴퓨팅
  • 금융 투자
  • 부동산

… 목록은 계속됩니다.

그러나 기술 세계의 복잡성을 번역하는 사람이 되기 위한 엄격한 요구 사항은 일상적인 작업이라는 점에서 공통적입니다.

영국 정부 디지털 서비스(UK Government Digital Service)의 기술 라이터, 서비스 디자인 및 보증인 Khidr Suleman에 따르면 다음은 그의 일상적인 업무입니다.

  • 사용자 연구에 참여
  • 콘텐츠 전략 만들기
  • 고위 이해 관계자에게 계획 발표
  • 사용자 여정 설계 및 프로토타이핑
  • 토론, 편집 및 (물론) 콘텐츠 작성

매우 다양합니다.

그러나 그 목록에서 마지막으로 중요한 것은 (물론) 그들이 실제로 하는 일을 하는 것이었습니다.

그러나 글쓰기(특히 기술적인 글쓰기)는 활동이라기보다는 과정입니다.

문서 전달을 집합적으로 이끄는 역할의 릴레이 경주.

간단히 말해서, 기술 문서 작성은 "빠르게 변화하는 소프트웨어 시스템에 대한 지식을 캡처, 구성 및 유지 관리하는" 프로세스로 설명될 수 있습니다. – Atom Bank

따라서 테크니컬 라이터의 일상에서 공통적인 특징은 리포지토리와 지식 기반을 처리하는 것입니다.

예를 들어 전문가 논평의 인용 또는 스니펫을 녹음합니다. 뿐만 아니라 인수를 검증하기 위해 사실 또는 데이터의 형태로 골든 너겟을 검색합니다.

요컨대, 쓰기를 제외하고 데이터 저장, 검색 및 위치 또는 발견의 용이성 또한 도움말 작성 도구의 중요한 관련 기능입니다.

2022년 도움말 작성 도구란 무엇입니까?

도움말 작성 도구에 대한 1페이지 Google 정의의 대부분을 믿는다면 정확한 설명에는 다음이 포함되어야 합니다.

  1. 만들기
  2. 관리
  3. 출판

…서류.

대부분은 '컨텐츠 관리 시스템'이 더 나은 아이덴티티라고 주장합니다.

이 용어가 CMS 공급업체가 작성한 기사에 포함되는 경향이 있다는 점은 인정하지만(그런 점에서 이 기사도 다르지 않을 것입니다), 정확도 사용을 조사하면 CMS는 결국 HAT에 대한 적절한 레이블입니다.

말 그대로 기술 작가의 도움말 문서를 작성하는 데 도움이 됩니다.

우리가 도움이 의미하는 바를 정확히 지적하는 한, 나는 당신이 그것을 얼마나 광범위하게 받아들일 수 있는지에 대한 엄격하고 빠른 규칙은 없다고 생각합니다.

그것은 실제로 다음에 달려 있습니다.

  1. 소프트웨어 제조업체가 기술 작문 분야를 얼마나 깊이 알고 있는지, 그리고;
  2. 그들이 필요를 충족하도록 얼마나 설득했는지

대부분의 경우 HAT는 제도 및 편집 기본 사항을 올바르게 수행하는 데 중점을 둡니다.

그리고 그 위에 약간의 템플릿, 스타일링 및 코딩을 제공합니다.

그러나 질문은…

...이러한 기능만으로도 현대 기술 작가의 가파른 요구 사항을 충족하기에 충분합니까?

몇 가지만 물어보면 어떨까요?…

  1. 이 피드백 발췌문에서 응답자(기술 작성자)는 기존 HAT 기능과 기존 CMS(Drupal)에 대한 비교 검토를 제공합니다.

“Drupal의 관리자는 페이지 목록을 볼 수 있지만 한 번에 한 페이지의 속성만 편집할 수 있습니다. 다중 선택 및 드래그 앤 드롭이 없습니다 . 따라서 주제 관리가 매우 힘들 수 있습니다.”

"페이지를 삭제하면 해당 페이지를 가리키는 모든 링크가 끊어 지고 경고 메시지가 표시되지 않습니다.

페이지에 링크를 만들 때 대상 페이지의 경로와 이름을 알아야 합니다 . 사용 가능한 페이지의 유용한 목록이 없습니다."

“기본적으로 WYSIWYG 편집기 는 없습니다 . 대부분의 HAT 사용자에게 이것은 필수입니다. 전체/필터링된 html로만 콘텐츠를 작성할 수 있습니다."

(출처: 체리잎)

  1. 이 논평에서 다른 직업 기술 작가는 HAT 소프트웨어의 미래 트렌드가 될 것이라고 생각하는 두 가지 이상적인 기능에 대해 논의했습니다.

"팩트 검색: 사용자가 검색 탭을 클릭하고 항목을 검색할 때 사용자 는 다음 이미지와 같이 유사한 패싯을 사용하여 검색 결과를 좁힐 수 있습니다 ."

“Flare, RoboHelp, Author-It, Doc-to-Help와 같은 표준 저작 도구를 사용하면 단일 조직의 단일 유리한 지점에서 작업하는 단일 저자의 우스꽝스러운 모델이 생성됩니다. 정보. 그 모델은 유지 및 확장이 불가능하기 때문에 HAT는 협업 웹 기반 저작 기술을 선호하게 될 것입니다 .”

(출처: 차라리 블로그를 쓰고 싶어요)

위에 제공된 통찰력은 기술 작성 생산성을 향상시키기 위한 보다 역동적이고 협업적인 플랫폼을 포함하도록 HAT의 전통적인 의미의 범위를 확장합니다.

도움말 작성에 CCMS(구성 요소 콘텐츠 관리 시스템) 사용을 고려해야 합니까?

세분성 선물 제어.

그리고 기술 문서 작성 분야에서 생산 주기 내에서 더 큰 제어의 이점은 더 큰 프로젝트 ROI로 변환되는 효율성을 낳습니다.

바로 여기에서 구성 요소 콘텐츠 관리 시스템이 등장합니다.

CCMS(구성 요소 콘텐츠 관리 시스템)란 무엇입니까?

구성 요소 콘텐츠 관리 시스템은 콘텐츠 항목이 페이지 및 게시물이 아니라 스니펫, 단락 및 콘텐츠 부분인 CMS입니다.

CMS에서 새로운 콘텐츠를 제작할 때와 마찬가지로 새 페이지나 게시물을 시작하게 됩니다.

CCMS를 사용하면 새 구성 요소(페이지 또는 게시물의 일부)를 시작할 수 있습니다.

많은 부분이 전체 페이지를 구성하므로 전체 페이지와 게시물의 최종 결과는 동일하지만 만드는 방식은 작은 덩어리로 나뉩니다.

왜요?

규모의 경제.

물론 하나의 자유로운 전체 조각보다 여러 조각(각각 고유한 메타데이터, 종속성 등을 가짐)을 기반으로 페이지를 작성하는 것이 더 많은 작업입니다.

그러나 많은 주제 교차 및 내부 참조가 있는 대규모 복잡한 콘텐츠 프로젝트에서 구성 요소 수준에서 재사용성과 세분화된 호환성을 참조하는 경우…

… CCMS는 팀을 작성하는 데 장기적으로 큰 이점을 제공합니다.

즉, 일을 더 빠르고 정확하게 처리합니다.

권장 도움말 저작 도구 조언 기사

가장 적합한 도움말 작성 도구를 선택하는 것은 단순한 '기능 및 이점' 비교 이상입니다.

최상의 결과를 얻으려면 사용성에 대해 깊이 파고들어야 합니다. 워크플로 및 작업 관리를 이해하면 각 솔루션이 제시하는 장단점을 파악하는 데 도움이 됩니다.

이 주제에 대한 동료 권장 조언을 돕기 위해 유용한 HAT 관련 기사의 빠른 목록을 모았습니다.

  1. HAT가 퇴색되는 이유
  2. 클라우드 기반 저작 도구 사용을 권장하는 5가지 이유
  3. HAT는 Drupal에 비해 무엇을 제공합니까?
  4. HAT 소프트웨어를 사용해야 하는 6가지 이유
  5. 테크니컬 라이터가 사용하는 5가지 저작 도구

위 기사의 저자는 HAT 주제에 대해 상당히 지식이 풍부하고 올바른 결정을 내리는 데 필요한 여러 내부 트랙 팁을 제공합니다.

HAT의 주요 기능은 무엇입니까?

따라서 우리는 HAT, HAT가 하는 일 및 기존 접근 방식 외에 고려해야 할 외부 이점에 대한 관점을 점차 확고히 하고 있습니다.

그러나 HAT가 처리하는 모든 것에 대한 포괄적인 참조를 갖는 것은 여전히 ​​가치가 있습니다.

이런 식으로 투자 선택을 고려할 때 '사과 대 사과'를 비교할 수 있습니다.

다음은 가장 일반적이고 가장 포괄적인 HAT 소프트웨어 기능의 목록입니다.

  • 다중 입력 및 출력 형식 : 다양한 파일 유형을 사용하여 데이터 가져오기 및 내보내기
  • 완전한 기능을 갖춘 워드 프로세서 : 코드 기반 및 시각적 WYSIWYG 편집기
  • 빌드 태그 : 기사를 주제별로 연결하기 위해 주제별 태그 할당
  • 주제 템플릿 : 사전 제작된 템플릿으로 모든 작품에서 우위 확보  
  • 구문 강조 표시 : 해결해야 할 문법 문제에 대한 유용한 강조 표시  
  • 프로젝트 전체 메타 정보를 위한 태그 병합 : 병합 태그를 사용하여 쉽게 재사용 가능한 스니펫 삽입, 시간 절약 및 오류 제한
  • 사용자 정의 HTML, CSS, Javascript: 사용자 정의 웹 코드로 기능 및 디자인에 맞춤형 터치 적용
  • 프로젝트 콘텐츠 병합 : 동일한 프로젝트 내의 콘텐츠를 결합하여 혼합된 결과를 생성합니다.  
  • 사용자 정의 가능한 웹 테마 : 사용자 경험을 개선하기 위해 도구의 프론트엔드를 완성하기 위한 스위치, 슬라이드 및 체크박스
  • 미디어 저장소 : 모든 이미지, PDF, 오디오 및 비디오 파일을 위한 깔끔한 저장 공간  
  • 쉬운 사용자 인터페이스 : 모든 관련 컨트롤과 함께 사용하기 쉽고 거리와 위치에 쉽게 도달할 수 있습니다.  
  • 번역 : 다국어 배송
  • 목차 : 내용을 훑어보기 위해 각 기사의 사용하기 쉬운 점프 링크  

전용 HAT 중에서 위의 사항은 내부적으로 예상되는 것의 대부분을 다룹니다.

맞춤형 HAT 구축의 이점

맞춤형 HAT 구축의 주요 이점을 요약해야 한다면 다음과 같이 말하고 싶습니다.

자신의 도구 세트를 마스터하십시오.

맞춤형 도구 모음

전문가로서 '원하는 것', '어디서, 어떻게 원하는지'가 있을 때 시간을 절약하고 개선된 결과에 대한 투자 수익은 측량할 수 없습니다.

성공을 위해 '적절하게' 제작된 도구를 사용하는 경험과 일반적인 '해야 할 일' 도구를 사용하는 경험을 비교할 수는 없습니다.

따라서 자신의 HAT를 사용자 정의하려면 상당한 선행 작업과 소란이 필요할 수 있습니다.

그러나 장기적으로 모든 프로젝트에서 개인 최고 기록을 경신하는 장면이 설정됩니다.

확장 가능

로드맵 개선 사항을 기다리거나 프리미엄 업그레이드에 얽매이는 일이 커스텀 HAT로 일어날 필요는 없습니다.

물론, 도구를 직접 수리하고 개선해야 할 책임이 있지만 약간의 DIY 시간으로 HAT의 수명을 적절하게 연장할 수 있습니다.

요컨대, HAT가 좋아지면 결과도 좋아질 것입니다.

더 나은 모든 라운드 성능

맞춤형 HAT는 기술 작성 워크플로에서 모든 사소하거나 방해가 되는 성가심을 제거합니다.

모든 병목 현상과 시간 낭비를 제거하고 바람에 따라 프로젝트를 마무리하는 데 경주를 제공하는 기능, 옵션 및 구성으로 대체합니다.

이전에는 가능하다고 생각했던 것을 쉽게 얻을 수 있습니다.

Heroic Knowledge Base 플러그인으로 WordPress 도움말 작성 도구 만들기

따라서 지금쯤 새로운 바다에 도전하고 자신만의 HAT를 만들기 위해 뛰어들 준비가 되셨다면 우리는 당신을 위한 솔루션을 가지고 있습니다.

사용하기 쉬운.

모든 온라인 웹사이트의 40% 이상이 사용하는 플랫폼을 기반으로 합니다.

모든 최고의 기능과 함께.

여기... WordPress를 사용하여 HAT를 만드는 사람에 대한 빠른 가이드입니다.

그리고 가장 좋은 점은 관련된 코드가 전혀 없다는 것입니다. 이 방법은 매우 초보자에게 친숙합니다.

다음은 라인업입니다.

  1. 페이지 및 파일 구성 및 분류
  2. 검색, 투표, 피드백 및 분석
  3. FAQ 구성 요소 복제
  4. 티켓을 통한 문의 처리를 위한 헬프 데스크
  5. 목차 페이지 색인
  6. 용어집 라이브러리

"WordPress를 사용해야 하는 이유"에 대한 간략한 요점.

대부분의 전문가에게는 작업에 가장 적합한 도구(이름에 관계없이)를 갖는 것이 가장 중요합니다.

의미론이나 이름 부름은 당신이 산출물에 빠져들고 당신을 파헤칠 토크가 있는 엔진이 필요하기 때문에 그다지 중요하지 않습니다.

이것이 바로 WordPress가 맞춤형 HAT를 만들기 위한 플랫폼으로 이상적인 곳입니다.

첫째, 이 기사의 앞부분에서 언급한 기능 라인업의 필수 상자를 모두 선택합니다. 그리고 핵심 제품을 사용하여 상자에서 꺼내자마자 쉽게 수행할 수 있습니다.

WYSIWYG 및 HTML, CSS 및 JS 코딩과 같은 기능은 WordPress(세계 최고의 콘텐츠 관리 시스템)에서 제공하는 표준 기능입니다.

그러나 WordPress는 또한 5조 달러의 호스팅, 플러그인 및 테마 경제를 호스팅합니다.

이 플레이어는 도구를 목적에 맞게 맞춤화하는 1급 확장 및 성능 지원을 제공할 책임이 있습니다.

대체로 WordPress와 플러그인 동반자는 자체 설정을 DIY하려는 기술 작가를 위해 HAT를 제공하는 드림 팀을 만듭니다.

다음은 WordPress를 사용하여 자신의 온라인 마켓플레이스를 구축하기 위한 권장 단계에 대한 개요입니다.

격리된 범주가 있는 디렉토리 홈 페이지: 완료된 프로젝트 및 조사된 리소스의 참조 라이브러리 색인 역할을 하는 허브 페이지. 기술 작성 로그에 액세스할 수 있는 깔끔한 위치입니다.

Heroic Knowledge Base 플러그인을 사용하여 이전에 게시한 HAT 콘텐츠의 자동 연결 및 항목별 라인업을 생성합니다.

검색, 투표, 피드백 및 분석: WordPress HAT 솔루션의 기능 내에서 역동성과 참여를 통합한 기사 앞부분에서 기여한 기술 작성자의 협업 요청에 주목했습니다. 검색, 피드백 및 통찰력을 제공하면 더 큰 개선 사항을 개발하는 데 도움이 됩니다.

Heroic Knowledge Base 플러그인을 사용하여 제품에 대한 반복적인 개선 로드맵을 지시하기 위한 사용자 연구 향상을 활성화하십시오.

FAQ 구성 요소 복제 : 자주 묻는 질문에 대한 세분화된 구성 요소 제어를 구성하여 더 큰 프로젝트를 확장하기 위해 더 적은 양의 프로덕션을 갖는 이점을 얻을 수 있습니다.

Heroic FAQ 플러그인을 사용하여 간단한 설치 및 세로 코드로 내장된 재사용 가능한 구성 요소로 HAT를 준비하십시오.

티켓을 통한 문의 처리를 위한 Heroic Inbox: WordPress 설치 내부에 있는 반응형 이메일 도움말 채널을 제공하는 사용자 지원 티켓을 편리하게 입력할 수 있습니다.

Heroic Inbox 플러그인을 사용하여 비즈니스 이메일 받은 편지함을 WordPress 관리 대시보드에 통합하세요. 이를 통해 HAT 내에 통합 커뮤니케이션 허브가 제공되므로 연결되지 않은 워크플로를 탐색하는 데 소요되는 시간을 절약할 수 있습니다.

Heroic Table of Contents: 기사를 쉽게 읽을 수 있는 점프 링크는 독자가 정보를 소화하고 가치를 추출하는 데 도움이 됩니다. 클래식 ToC를 사용하여 부품을 더욱 유용하게 만드십시오.

Heroic 목차를 사용하여 각 기사에 자동으로 채워지는 목차를 추가하십시오.

Heroic Glossary: ​​프로젝트의 핵심 단어 정의에 액세스하는 지름길로 유용한 용어의 AZ 목록을 컴파일하여 새 프로젝트를 작성하는 동안 민첩성을 유지합니다.

Heroic Glossary 플러그인을 사용하여 검색 가능한 용어집을 WordPress HAT에 설치하십시오. 땀과 (다시) 코드가 필요 없습니다.

Aspose.Words: WordPress 게시물 또는 페이지를 DOC 또는 DOCX 파일로 또는 그 반대로 즉시 변환합니다. 워크플로 격차를 해소하고 기존 GDoc 또는 Word 문서 자산과 호환되는 새 시스템을 만드십시오.

Aspose.Words 플러그인을 사용하여 WordPress와 GDocs 또는 Word 간의 양방향 파일 변환을 활성화합니다.

Syntax Highlighter Evolved: 사용자 정의 편집을 수행할 때 웹 코드를 눈에 띄게 만들어 주의를 산만하게 하지 않고 세부 사항에 집중할 수 있습니다.

Syntax Highlighter Evolved 를 사용하여 웹에 능숙한 편집을 할 때 코드를 아름답게 만드십시오.

결론

이러한 고급 CMS의 요즈음에 특별히 제작된 HAT는 아마도 바퀴를 재발명하고 있을 것입니다.

실제로 가장 진보된 기능을 갖춘 HAT라도 일부 구성이 있는 CMS가 할 수 없는 일을 할 수 있는 일은 많지 않습니다.

또한 CMS를 사용하면 이미 경쟁력 있는 제품에 이점을 추가하는 추가 기능이 있습니다.

CMS(플러그인으로 시장을 주도하는 WordPress)가 제공하는 추가 잠재력은 유사 HAT 솔루션을 기대 이상으로 확장할 수 있습니다.

자신의 가려움을 긁고 WordPress로 계속 혁신할 수 있는 충분한 공간이 있으며 코딩이 필요하지 않습니다.

빠르게 확장되는 타사 플러그인 생태계는 가능성의 한계를 뛰어 넘는 전문 제품으로 WordPress의 시장 점유율 이점을 지원합니다.

전반적으로 미래에 대비한 맞춤형 HAT 투자를 원하신다면 WordPress CMS가 이상적인 디지털 플랫폼이라고 확신합니다.

오늘 시작하지 않으시겠습니까?