이 템플릿은 지식이 풍부한 기사를 작성하기 위한 표준을 설명합니다. Apple의 기술 자료 문서를 예로 사용: https://support.apple.com/en-ca/HT207935
제목
기사 제목은 기사 내용을 반영하여 쉽게 알아볼 수 있고 검색이 용이하도록 해야 합니다.
예: "노래를 어떻게 삭제합니까?", "Anytune iPhone/iPad에 오신 것을 환영합니다."
지침
- 중복 기사를 작성하지 마십시오. 만들기 전에 주의 깊게 검색하십시오.
- 제목은 "제목 2"로 시작합니다. 기사 제목은 제목 1이며 하나만 있어야 합니다.
- 제품 이름과 텍스트 버튼 이름을 대문자로 사용:
편집 버튼을 누릅니다. 굵게 명령하지 마십시오. - 버튼이 아이콘을 사용하는 경우 22픽셀 높이의 버튼 테이블 이미지(svg)를 사용합니다.
복원을 탭합니다
- 옵션 선택 시 따옴표 사용:
3. "조정된 노래" 및 "이메일" 선택 - 다음 계층의 경우 다음을 사용합니다.
Anytune 메뉴 > 파일 > 구성 내보내기 > 파일로 내보내기...로 이동합니다. - 절차의 단계에 번호가 매겨진 목록을 사용합니다.
단계는 기간 내에 종료됩니다. - 절차 제목은 H@이고 콜론으로 끝납니다. 예: "절차 제목:"
- 제품 버전에 따라 단계가 다른 경우 설명 제목 3 제목이 있는 여러 섹션을 만듭니다.
- 목록에 글머리 기호를 사용합니다.
- 고객의 컨텍스트 유지
- 청중을 기억하십시오
- 고객을 참조하지 마십시오.
- 약어 및 두문자어 사용 자제
- 모든 링크가 작동하는지 확인
라벨
기사에 적절한 레이블을 포함시키십시오. 레이블은 기사 검색 관련성과 답변 봇 결과에 영향을 미칩니다. 또한 기사 목록을 만드는 데 사용할 수도 있습니다.
가능한 한 단어를 사용하고 같은 단어의 변형을 사용하지 마십시오. 레이블을 아껴서 사용하십시오.
예: macOS, 가져오기, 블루투스, ReFrame
주형
이 기사에서 알려줄 내용에 대한 요약 설명입니다.
프로세스 및 플랫폼 구분을 위해 제목 3을 사용하십시오.
- 프로세스 단계
- 탭
도움말 버튼 - "이메일"을 선택하십시오
- 수정을 탭합니다.
Mac에서 이에 대한 프로세스는 다음과 같습니다.
참고: <p class="anytune-note">note</p>에 메모를 제공하세요.
경고: <p class="anytune-warning">메모</p>에 메모 제공
<p class="anytune-highlight">메모</p>로 강조 표시하여 강조
자세히 알아보기(H3)
추가 정보가 있는 위치를 링크로 사용자에게 알립니다.
문제를 수정하는 방법
문서에서 문제 해결 방법을 설명할 때 다음 섹션을 포함합니다.
- 문제: 문제를 설명하고 클라이언트의 말을 사용하십시오.
- 환경: 이 수정 사항이 적용되는 설정 및 구성 설명(선택 사항)
- 해결: 해결 단계는 다음과 같습니다.
- 원인: 어떤 시나리오가 문제를 일으켰거나 문제를 일으켰을 수 있습니까?
- 레이블: 도움이 되도록 문제의 기사와 관련된 단어를 포함합니다.
댓글
댓글 0개
댓글을 남기려면 로그인하세요.