다음을 통해 공유

편집기 검사 목록

이 문서에는 PowerShell 설명서를 작성하거나 편집하기 위한 규칙 목록이 요약되어 있습니다. 이러한 규칙에 대한 자세한 설명과 예제는 기여자 가이드의 다른 문서를 참조하세요.

메타데이터

  • ms.date: MM/DD/YYYY 형식이어야 합니다.
    • 중요하거나 사실적인 업데이트가 있는 날짜 변경
      • 문서 재구성
      • 팩트 오류 수정
      • 새 정보 추가
    • 업데이트가 중요하지 않은 경우 날짜를 변경하지 마세요.
      • 오타 및 서식 수정
  • title: 43~59자 길이의 고유 문자열(공백 포함)
    • 사이트 식별자를 포함하지 않음(자동 생성됨)
    • 문장 대/소문자 사용 - 첫 번째 단어와 적절한 명사만 대문자로 표시
  • description: 공백을 포함하여 115-145자 - 이 추상은 검색 결과에 표시됩니다.

서식

  • 단락 내에 인라인으로 표시되는 백틱 구문 요소
    • Cmdlet 이름 Verb-Noun
    • 변수 $counter
    • 구문 예제 Verb-Noun -Parameter
    • 파일 경로 C:\Program Files\PowerShell, /usr/bin/pwsh
    • 문서에서 클릭할 수 없는 URL
    • 속성 또는 매개 변수 값
  • 속성 이름, 매개 변수 이름, 클래스 이름, 모듈 이름, 엔터티 이름, 개체 또는 형식 이름에 굵게 사용
    • 굵게는 강조가 아닌 의미 체계 태그에 사용됩니다.
    • 굵게 - 별표 ** 사용
  • 이탤릭 - 밑줄을 사용하다 _
    • 강조를 위한 목적으로만 사용되며, 의미적 태그에는 사용되지 않습니다.
  • 100자에서 줄 바꿈(또는 about_Topics의 경우 80자)
  • 하드 탭 없음 - 공백만 사용
  • 줄에 후행 공백 없음
  • PowerShell 키워드 및 연산자는 모두 소문자여야 합니다.
  • cmdlet 이름 및 매개 변수에 적절한 파스칼 케이스 사용

헤더

  • 먼저 H1 시작 - 아티클당 하나의 H1만
  • ATX 헤더는만 사용
  • 모든 헤더에 문장 대/소문자 사용
  • 수준을 건너뛰지 마세요. H2가 없으면 H3도 없습니다.
  • 헤더 깊이를 H3 또는 H4로 제한
  • 앞과 뒤의 빈 줄 추가
  • 헤더 추가 또는 제거 안 함 - PlatyPS는 해당 스키마에 특정 헤더를 적용합니다.

코드 블록

  • 앞과 뒤의 빈 줄 추가
  • 태그가 지정된 코드 펜스 사용 - powershell, 출력또는 기타 적절한 언어 ID
  • 구문 블록에 태그가 지정되지 않은 코드 펜스 사용
  • 판독기에서 복사 단추를 사용하지 않으려는 기본 예제를 제외하고 별도의 코드 블록에 출력을 배치합니다.
  • 지원되는 언어 목록을 참조하세요.

목록

  • 제대로 들여쓰기
  • 첫 번째 항목 앞과 마지막 항목 뒤의 빈 줄 추가
  • 별표(-)가 아닌 글머리 기호에 하이픈(*)을 사용하여 강조와 혼동을 줄입니다.
  • 번호가 매겨진 목록의 모든 항목에 대해 1.을 사용하십시오.

용어

Cmdlet 참조 예제

  • cmdlet 참조에 하나 이상의 예제가 있어야 합니다.

  • 예제는 사용량을 보여 주는 데 충분한 코드여야 합니다.

  • PowerShell 구문

    • cmdlet 및 매개 변수의 전체 이름 사용 - 별칭 없음
    • 명령줄이 너무 길어지면 매개 변수에 스플래팅 사용
    • 줄 연속 백틱을 사용하지 마세요. 필요한 경우에만 사용

  • 예제에 필요한 경우를 제외하고 PowerShell 프롬프트(PS>)를 제거하거나 간소화합니다.

  • Cmdlet 참조 예제는 다음 PlatyPS 스키마를 따라야 합니다.

    ### Example 1 - Descriptive title

Zero or more short descriptive paragraphs explaining the context of the example followed by one or
more code blocks. Recommend at least one and no more than two.

```powershell
... one or more PowerShell code statements ...
```

```Output
Example output of the code above.
```

Zero or more optional follow up paragraphs that explain the details of the code and output.

  • 코드 블록 사이에 단락을 배치하지 마세요. 모든 설명 콘텐츠는 코드 블록 앞이나 후에 와야 합니다.

다른 문서에 연결

  • 문서 집합 외부 또는 cmdlet 참조와 개념 간에 연결하는 경우
    • Microsoft Learn에 연결할 때 사이트 상대 URL 사용(https://learn.microsoft.com/en-us제거)
    • Microsoft 속성의 URL에 로캘을 포함하지 않음(URL에서 /en-us 제거)
    • 대상 사이트에 유효하지 않은 경우 외부 웹 사이트에 대한 모든 URL은 HTTPS를 사용해야 합니다.
  • 문서 세트 내에서 연결하는 경우
    • 상대 파일 경로 사용(../folder/file.md)
  • 모든 경로는 슬래시(/) 문자를 사용합니다.
  • 이미지 링크에는 고유한 대체 텍스트가 있어야 합니다.