PowerShell 설명서에 기여하기 시작

2025-05-06

이 문서는 PowerShell 설명서의 기여자로 시작하는 방법에 대한 개요입니다.

PowerShell-Docs 구조체

PowerShell-Docs 리포지토리에는 세 가지 범주의 콘텐츠가 있습니다.

참조 콘텐츠
개념적 콘텐츠
메타데이터 및 구성 파일

참조 콘텐츠

참조 콘텐츠는 PowerShell에서 제공되는 cmdlet에 대한 PowerShell cmdlet 참조입니다. cmdlet 참조은 PowerShell과 함께 제공되는 모듈에 대한 참조를 포함하는 폴더(예: 5.1, 7.4, 7.5 및 7.6 버전)로 수집됩니다. 이 콘텐츠는 Get-Help cmdlet에 표시되는 도움말 정보를 만드는 데도 사용됩니다.

개념 콘텐츠

개념 설명서 버전별로 구성되지 않습니다. 모든 PowerShell 버전에 대해 모든 문서가 표시됩니다.

메모

개념 문서를 추가, 제거 또는 이름을 바꿀 때마다 TOC를 업데이트해야 합니다. 삭제되거나 이름이 바뀐 모든 파일을 리디렉션해야 합니다.

메타데이터 파일

이 프로젝트에는 여러 유형의 메타데이터 파일이 포함되어 있습니다. 메타데이터 파일은 빌드 도구 및 게시 시스템의 동작을 제어합니다. PowerShell-Docs 유지 관리자 및 승인된 기여자만 이러한 파일을 변경할 수 있습니다. 메타 파일을 변경해야 한다고 생각되면 문제를 열어 필요한 변경 내용을 논의합니다.

리포지토리의 루트에 있는 메타 파일

.* - 리포지토리의 루트에 있는 구성 파일
*.md - 리포지토리의 루트에 있는 프로젝트 설명서
*.yml - 리포지토리의 루트에 있는 프로젝트 설명서
.devcontainer/* - devcontainer 구성 파일
.github/**/* - GitHub 템플릿, 작업 및 기타 메타 파일
.vscode/**/* - VS Code 확장 구성
assets/* - 설명서에 연결된 다운로드 가능한 파일 포함
redir/* - 리디렉션 매핑 파일 포함
tests/* - 빌드 시스템에서 사용하는 테스트 도구
tools/* - 빌드 시스템에서 사용하는 기타 도구

설명서 집합의 메타 파일

reference/**/*.json - docset 구성 파일
reference/**/*.yml - TOC 및 기타 구조적 콘텐츠 파일
reference/bread/* - 브레드크럼 내비게이션 구성
reference/includes/* - 마크다운 포함 파일
reference/mapping/* - 버전 매핑 구성
reference/**/media/** - 설명서에 사용되는 이미지 파일
reference/module/* - 모듈 브라우저 페이지 구성

새 문서 만들기

기여하려는 새 문서에 대해 GitHub 문제를 만들어야 합니다. 기존 문제를 확인하여 작업이 중복되지 않는지 확인합니다. 할당된 문제는 in progress으로 간주됩니다. 문제에 대해 공동 작업하려면 문제에 할당된 사람에게 문의하세요.

PowerShell RFC 프로세스마찬가지로 콘텐츠를 작성하기 전에 문제를 만듭니다. 이 문제는 PowerShell-Docs 팀에서 거부되는 작업에 시간과 노력을 낭비하지 않도록 합니다. 이 문제를 통해 콘텐츠 범위 및 PowerShell 설명서에 맞는 위치에 대해 귀하와 상의할 수 있습니다. 모든 항목은 목차에 포함되어야 합니다. 제안된 TOC 위치는 문제 토론에 포함되어야 합니다.

메모

게시 시스템은 참조 콘텐츠에 대해 TOC를 자동으로 생성합니다. TOC를 업데이트할 필요가 없습니다.

기존 문서 업데이트

해당하는 경우 이 리포지토리에 유지 관리되는 모든 버전의 PowerShell에서 cmdlet 참조 문서가 중복됩니다. cmdlet 참조 또는 About_ 문서에 대한 문제를 보고할 때 문제가 있는 아티클의 버전을 나열합니다.

파일의 각 버전에 적절한 변경 사항을 적용합니다.

지역화된 콘텐츠

PowerShell 설명서는 영어로 작성되었으며 다른 17개 언어로 번역되었습니다. 영어 콘텐츠는 MicrosoftDocs/PowerShell-Docs이라는 GitHub 리포지토리에 저장됩니다. 번역된 콘텐츠에 있는 문제는 이 리포지토리에 제출해야 합니다.

모든 번역은 먼저 영어 콘텐츠에서 시작합니다. 우리는 인간과 기계 번역을 모두 사용합니다.

번역 방법	언어들
인간 번역	de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
기계번역	cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

기계 번역으로 번역된 콘텐츠가 항상 올바른 단어 선택 및 문법을 초래하지는 않을 수 있습니다. 문서의 기술 세부 정보가 아닌 모든 언어에 대한 번역 오류가 발견되면 번역이 잘못된 이유를 설명하는 문제를 엽니다.

영어 원본 파일을 변경하여 일부 번역 문제를 해결할 수 있습니다. 그러나 일부 문제에는 내부 번역 시스템에 대한 업데이트가 필요할 수 있습니다. 이러한 경우 내부 지역화 팀에 검토 및 응답을 위해 문제를 제출해야 합니다.

다음 단계

GitHub에는 변경 내용을 제출하는 두 가지 일반적인 방법이 있습니다. 두 방법 모두 중앙 기여자 가이드에 설명되어 있습니다.

GitHub 웹 인터페이스에서 기존 문서를 빠르게 편집할 수 있습니다.
새 아티클 추가, 여러 파일 업데이트 또는 기타 큰 변경 내용에 전체 GitHub 워크플로 사용합니다.

변경 내용을 시작하기 전에 PowerShell-Docs 리포지토리의 포크를 만들어야 합니다. PowerShell-Docs 복사본의 작업 분기에서 변경해야 합니다. GitHub에서 빠른 편집 방법을 사용하는 경우 이러한 단계가 자동으로 처리됩니다. 전체 GitHub 워크플로를 사용하는 경우 로컬로 작동하도록 설정해야 합니다.

두 방법 모두 끌어오기 요청(Pull Request, PR)을 만드는 것으로 끝납니다. 자세한 내용 및 모범 사례는 끌어오기 요청 제출을 참조하세요.