참조 콘텐츠 형식

참조 콘텐츠는 사용자가 기능을 적극적으로 사용하는 동안 필요한 자세한 정보를 제공합니다.

이 기사에서

참조 콘텐츠는 특정 정보에 대해 참조됩니다. 그것은 당신이 신속하게 확인할 수있는 정보입니다, 문장과 단락에 덜 강조가 있다는 것을 의미.

참조에는 테이블, 목록 또는 기타 구조화된 형식으로 가장 잘 표현될 수 있는 정보가 포함됩니다. 참조는 자동 생성된 파이프라인 콘텐츠 및 잠재적으로 자동화될 수 있는 기타 콘텐츠를 포함하는 것으로 간주할 수 있습니다.

참조 콘텐츠는 참조 문서 및 다른 문서 내의 참조 섹션에 나타납니다.

  • 특히 검색 구문 또는 YAML 구문과 같은 많은 양의 참조 콘텐츠가 있는 경우 일부 주요 주제에는 자체 참조 문서가 필요할 수 있습니다 GitHub Actions.
  • 기능의 지원되는 언어 또는 하드웨어 요구 사항 목록과 같은 더 적은 양의 콘텐츠 또는 보다 구체적인 정보의 경우 절차 또는 개념 문서 내의 컨텍스트에서 참조 섹션을 사용합니다.

참조 콘텐츠를 작성하는 방법

참조 콘텐츠 템플릿은 템플릿을 참조하세요.

  • 문장 또는 전체 개념 섹션을 작성하여 참조 콘텐츠를 소개합니다.
  • 실제 참조 콘텐츠를 명확하고 일관되게 표시합니다.
  • 설명할 단일 요소가 있는 주체의 경우 목록을 사용하세요.
  • 설명할 요소가 여러 가지 있는 주체의 경우 표를 사용하세요.
  • 워크플로에 대한 YAML 구문과 같은 더 긴 참조 콘텐츠의 경우 머리글을 일관되게 사용하세요.

참조 콘텐츠 제목

  • 참조 구역의 참조 문서 또는 머리글은 구역의 내용을 명확하게 설명하고 일반적으로 명사로 시작하세요.
  • 제목에는 초보 사용자가 액세스할 수 있는 충분한 정보가 포함되어 있으며 각 구역의 내용을 완전히 설명하세요.
  • 제목은 겹친 명사를 쓰지 말고, 전치사로 긴 명사 문자열을 분리하세요.
  • 짧은 제목은 한 단어 또는 짧은 명사 구여야 합니다. 예: "AI 모델".

참조 콘텐츠의 예