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