위키백과:도움말 프로젝트/가이드라인

Wikipedia:
메인 페이지 토론 범위 지침 템플릿 참가자 뉴스레터

도움말 페이지는 설명, 지침 및 실제 지침을 제공한다.이 문서는 편집자의 질문에 답하고 문제를 해결하는 유용하고 간단하며 접근 가능한 도움말 페이지를 만들기 위해 도움말 페이지 설계 원칙을 제시한다.

사용자 및 사용 사례에 집중

독자들이 해결하려고 하는 문제에 대해 독자들에게 말하라.

  • "참조 추가", "테이블 사용자 지정"과 같은 현재 시제 언어 사용...
  • "I want to...", "어떻게...?"
  • 실제 사람들이 실제 문제를 해결하도록 도와라.그들에게 필요 없는 많은 배경을 주지 마라.

독자들을 격려하고 안심시키십시오.

독자들에게 그들이 시작한 것 보다 더 자신감과 이해심을 남겨라.

  • 대화 스타일은 특히 새로운 사용자를 위해 페이지가 더 쉽게 접근하고 작업할 수 있도록 도울 수 있다.
  • 도움말 기사를 모두 읽지 않은 독자들이 멍청하다고 느끼거나 죄책감을 느끼도록 하지 마십시오.

단순하게 받아들여라.

가장 일반적인 경로에 초점을 맞추고 쉽게 볼 수 있도록 함

  • 문장과 단락을 짧게 유지하라.문장은 25단어 미만이어야 한다.단락은 한 가지 주제에만 초점을 맞춰야 한다.
  • 형식 표준화
  • 간단한 요약 포함
  • 예제 포함(샘플 코드 등)
  • 복잡한 프로세스를 단계별로 구분
  • 일관된 용어 사용
  • 가장 간단한 경로:
    • 예: 사용자 css/js 편집 대신 Gadgets, 수동 코딩 인용문 대신 RefToolbar를 추천
  • 오버링 방지

항법 수술의 명확성과 명확성 확인

가장 일반적인 경로를 차트화하여 쉽게 찾을 수 있도록 함

  • 짧고 선명한 리드 및/또는 {{nutshell}} 요약 작성
  • 간략한 개요 또는 기술 도움말 문서를 사용할 수 있는 경우 참고
  • 사용자에게 다음에 어디로 가야 할 지에 대한 명확한 진행 과정을 안내
  • 적절한 네임스페이스 사용
    • 정책, 지침 및 프로세스가 위키백과: 네임스페이스,
    • MediaWiki 기능에 대한 지침, 사용 방법, 자습서 및 설명은 도움말: 네임스페이스에 있어야 한다.

시각적으로 매력적인 도움말 페이지 설계

명확한 설계로 사용자를 유인

  • 페이지를 섹션 및 하위 섹션으로 분할
  • 리치 미디어로 기사 설명
    • 스크린샷(.jpeg이 아닌 고품질 .png)
    • 스크린캐스트(비디오)
  • 접근성을 손상시키지 마십시오.
    • 영상에 Alt 텍스트가 있어야 함
    • 표에는 적절한 경우 합리적인 제목과 표제가 있어야 한다.
  • 적절한 경우 {{notice}, {{주의}} 등의 템플릿을 사용하십시오.

도움말 페이지를 다양한 수준의 경험으로 대상 지정

가장 효과적인 솔루션으로 가장 일반적인 문제를 해결하는 개요 작성

  • 간단하고 짧으며 압도적이지 않은 크래프트 인트로 기사
    • 이전에 소개되지 않은 용어에 대한 링크
    • 사용 가능한 가장 복잡한 기술 페이지에 대한 링크
  • 고급 및 고도로 구체적인 사용 사례 분리 및 최소화
    • 필수 정보가 아닌 추가 정보에 각주 사용
  • {{Collapse}}박스에 큰 블록의 코드, 예시, 희귀 케이스 포장

참고 항목

외부 링크

기타 설명서 스타일 가이드