문서 작성 돕기¶
Python은 잘 작성된 문서로 유명합니다. 문서의 정확성과 높은 품질을 유지하려면 많은 노력이 필요합니다. 여러분과 같은 커뮤니티 구성원은 콘텐츠 작성, 편집, 업데이트를 도우며, 이러한 기여는 높이 평가되고 환영받습니다.
이 상위 수준의 문서 작성 돕기 섹션에서는 다음 내용을 제공합니다:
Python 문서 개요
문서 이슈를 돕는 방법
교정에 관한 정보
문서를 작성하고 변경 사항을 제출하는 방법에 관한 광범위하고 자세한 정보는 Python 문서 작성 페이지에서 확인할 수 있습니다.
Python 문서¶
관련 Python 문서 작성 섹션에서는 Python 문서가 작동하는 방식에 관한 세부 사항을 다룹니다. 여기에는 사용되는 마크업 언어, 특정 형식, 스타일 권장 사항에 관한 정보가 포함됩니다. 시작할 때 기존 문서 소스 파일을 살펴보면 매우 유용할 수 있습니다. 문서 빌드 방법에서는 변경 사항이 어떻게 보이는지 확인하고 새 마크업이 올바른지 검증할 수 있는 초안 빌드를 만드는 단계를 안내합니다.
https://docs.python.org/dev/에서 개발 중 및 유지보수 브랜치로부터 빌드된 문서를 볼 수 있습니다. 개발 중인 브랜치와 최근 유지보수 브랜치는 하루에 한 번 다시 빌드됩니다.
문서 작업에 더 깊이 참여하고 싶다면 사용자 이슈가 제기되고 문서 도구 체인, 프로젝트, 표준이 논의되는 Python Discourse의 문서 카테고리 및 docs@python.org 메일링 리스트를 구독해 보십시오.
문서 이슈 돕기¶
이슈 추적기에서 문서 이슈를 살펴보면, 작업이 필요할 수 있는 다양한 문서 문제를 찾을 수 있습니다. 이슈는 오타부터 불명확한 문서와 문서가 없는 항목까지 다양합니다.
해결하고 싶은 문서 이슈를 발견하면 다음과 같이 할 수 있습니다:
이슈 제목 오른쪽에 풀 리퀘스트 아이콘이 있는지 또는 이슈 본문의 Linked PRs아래에 열린 풀 리퀘스트가 나열되어 있는지 확인하십시오. 있다면 누군가가 이미 해당 이슈에 대한 풀 리퀘스트를 만든 것입니다.
풀 리퀘스트 작성을 시도하겠다는 내용과 완료하는 데 걸릴 것으로 예상하는 대략적인 시간을 이슈에 댓글로 남기십시오(혹시 잊거나 흥미를 잃더라도 다른 사람이 이슈를 맡을 수 있습니다).
해당 이슈에 대한 풀 리퀘스트를 제출하십시오.
관련 풀 리퀘스트 빠른 안내서의 단계를 따르면 문서 풀 리퀘스트의 작업 흐름을 익힐 수 있습니다.
번역¶
Python 문서는 여러 언어로 활발히 번역되고 있습니다. 번역을 돕는 데 관심이 있다면 번역 페이지를 참조하여 시작하십시오.
교정¶
이슈 추적기에 등록된 이슈는 어딘가에 알려진 문제가 있다는 뜻이지만, 그렇다고 문서 곳곳에 다른 문제가 숨어 있지 않다는 뜻은 아닙니다. “방법” 문서나 특정 OS용 문서처럼 문서의 일부를 교정하면 문제를 발견하는 경우가 많습니다(예: Python 3에 맞게 업데이트해야 하는 문서).
교정을 하기로 했다면 문서의 한 섹션을 처음부터 끝까지 읽고, 발견한 주요 문제 유형별로 이슈 추적기에 이슈를 등록하십시오. 단순한 오타에는 별도의 이슈가 필요하지 않으며, 대신 풀 리퀘스트를 직접 제출하십시오. 여러 문제가 있는 섹션 전체를 하나의 이슈로 등록하지 않는 것이 좋습니다. 대신 여러 사람이 작업을 쉽게 나누고 더 효율적으로 검토할 수 있도록 여러 이슈로 나누어 등록하십시오.
영어 기술 문서 작성의 세부 사항에 관한 도움이 필요하면, python 저장소의 이슈나 풀 리퀘스트에서 @python/proofreaders 팀을 언급하십시오. 팀에 가입하고 싶다면 core-workflow 이슈를 개설하되, python/core-workflow#461와 유사하게 작성하십시오.