품질 향상에 기여

Hacktoberfest 2022의 경우 PowerShell 콘텐츠에 품질 향상에 기여하는 프로세스를 파일럿했습니다. 이 가이드에서는 커뮤니티 구성원이 설명서의 품질을 개선할 수 있는 낮은 마찰 방법을 정의하는 프로세스를 일반화합니다.

우리는 이러한 품질 영역에 초점을 맞추고 있습니다.

프로젝트 추적

PowerShell Docs 품질 기여 GitHub 프로젝트를 사용하여 기여를 추적하고 있습니다.

프로젝트 페이지에는 이 작업과 관련된 문제 및 PR에 대한 몇 가지 보기가 있습니다.

열려 있는 문제 보기에는 열려 있는 모든 문제가 표시됩니다.
완료된 보기에는 병합된 PR이 표시됩니다.
PowerShell 보기는 PowerShell-Docs, PowerShell-Docs-DSC 및 PowerShell-Docs-Modules 리포지토리의 설명서에 대한 미해결 문제를 보여 줍니다.
Windows PowerShell 보기에는 windows-powershell-docs 리포지토리의 설명서에 대한 미해결 문제가 표시됩니다.
Azure PowerShell 보기는 azure-docs-powershell 리포지토리의 설명서에 대한 미해결 문제를 보여 줍니다.
열린 PR 보기에는 모든 열린 PR이 표시됩니다.

모든 코드 샘플은 PowerShell 콘텐츠에 대한 스타일 지침을 따라야 합니다. 이러한 규칙은 편의를 위해 여기에서 축약된 형식으로 반복됩니다.

모든 코드 블록은 트리플 백틱 코드 펜스(```)에 포함되어야 합니다.
코드 블록의 줄 길이는 cmdlet 참조 아티클의 문자로 90 제한됩니다.
코드 블록의 줄 길이는 76자로 제한되며, 이는 about_* 아티클에 적용됩니다.
PowerShell 코드 예제에서는 줄 연속 문자(`)를 사용하지 마세요.
- 파이프(|) 문자, 여는 중괄호(}), 괄호((), 대괄호([) 뒤와 같은 자연스러운 줄 바꿈 기회와 스플래팅을 사용하여 줄 길이를 제한합니다.
코드가 복사 붙여넣기용이 아닌 예시 예제에 대한 PowerShell 프롬프트만 포함합니다.
별칭을 구체적으로 문서화하지 않는 한 예제에서는 별칭을 사용하지 마세요.
위치 매개 변수를 사용하지 않습니다. 매개 변수가 위치인 경우에도 매개 변수 이름을 사용합니다.

모든 산문은 PowerShell 콘텐츠에 대한 스타일 지침을 따라야 합니다. 이러한 규칙은 편의를 위해 여기에서 반복됩니다.

항상 cmdlet 및 매개 변수의 전체 이름을 사용합니다. 별칭을 구체적으로 표시하지 않는 한 별칭을 사용하지 마세요.
속성, 매개 변수, 개체, 형식 이름, 클래스 이름, 클래스 메서드는 굵게 표시되어야 합니다.
- 속성 및 매개 변수 값은 백틱(`)으로 래핑되어야 합니다.
- 대괄호 스타일을 사용하여 형식을 언급할 때는 백틱을 사용합니다. 예: [System.Io.FileInfo]
PowerShell 모듈 이름은 굵게 표시되어야 합니다.
PowerShell 키워드 및 연산자는 모두 소문자여야 합니다.
cmdlet 이름 및 매개 변수에는 적절한 파스칼 표기법의 대/소문자 사용을 권장합니다.
이름으로 매개 변수를 참조하는 경우 이름은 굵게 표시되어야 합니다.
구문을 설명하는 경우 하이픈과 함께 매개 변수 이름을 사용합니다. 매개 변수를 백틱으로 래핑합니다.
외부 명령의 사용 예제를 보여 주면 예제를 백틱으로 래핑해야 합니다. 항상 외부 명령의 파일 확장명을 포함합니다.

설명서에 대한 markdown 원본의 유지 관리 및 가독성을 위해 개념 설명서를 인라인 링크 대신 링크 참조를 사용하도록 변환하고 있습니다.

예를 들어 다음 식을 사용하는 대신

The [Packages tab][31] displays all available
packages in the PowerShell Gallery.

다음과 같아야 합니다.

The [Packages tab][31] displays all available packages in the PowerShell Gallery.

비고

인라인 링크를 바꿀 때, 콘텐츠를 다시 조정하여 100자에서 줄바꿈을 하도록 합니다. 리플로 마크다운 VS Code 확장을 사용하여 단락을 빠르게 다시 입력할 수 있습니다.

파일 아래쪽에서 링크 정의 앞에 markdown 주석을 추가합니다.

<!-- Link references -->
[01]: https://www.powershellgallery.com/packages

다음을 확인하십시오:

참여하는 리포지토리 중 하나의 아티클에 대해 VS Code에서 문서를 열면 Linting 경고가 표시됩니다. 발견한 경고 중 다음을 제외하고 해결하십시오.

cmdlet 참조 문서의 헤더에 Synopsis 규칙을 적용합니다. 이러한 항목의 경우 규칙 위반은 설명서가 PlatyPS를 사용하여 올바르게 빌드되도록 하기 위한 의도적인 것입니다.

줄 길이를 확인하고 Reflow Markdown 확장을 사용하여 긴 줄을 수정합니다.

최선의 노력에도 불구하고 오타와 맞춤법 오류는 설명서를 통과하여 끝납니다. 이러한 실수는 설명서를 따르고 지역화하기 어렵게 만듭니다. 이러한 실수를 수정하면 특히 정확한 번역에 의존하는 영어가 아닌 사용자를 위해 설명서를 더 쉽게 읽을 수 있습니다.

개선하려면 품질 영역 중 하나 이상과 아티클(또는 문서 그룹)을 선택하는 것이 좋습니다. 다음 단계를 사용하여 작업을 안내합니다.