현재 단계:
2019년 Docs 시즌 프로그램은 2020년 3월 6일에 종료되었습니다. 타임라인을 참고하세요.
이 페이지에는 테크니컬 라이터가 Docs 시즌에 참여하기 위해 애플리케이션의 주요 부분을 완료하는 방법에 대한 힌트가 포함되어 있습니다. 이 정보는 오픈소스 조직이 Docs 시즌 중 멘토링할 기술 문서 작성 프로젝트를 선택할 때 고려할 수 있는 요소를 이해하는 데 도움이 됩니다.
소개
아래의 가이드라인은 일반적으로 문서 시즌에 적용됩니다. 각 오픈소스 조직에는 특정 평가 기준이 있을 수 있습니다. 신청서를 제출하기 전에 참여 조직에 연락하여 요구사항을 논의하고 프로젝트 제안서를 계획할 수 있습니다. 테크니컬 라이터 가이드에 설명된 테크니컬 라이터 탐색 단계를 참조하세요.
신청서
신청 양식은 테크니컬 라이터 신청 단계 동안 테크니컬 라이터 가이드에서 확인할 수 있습니다.
양식을 제출한 후 테크니컬 라이터 신청 단계(2019년 6월 28일)가 끝날 때까지 양식의 정보를 계속 업데이트할 수 있습니다.
개인 정보
신청서 양식에서는 다음과 같은 개인 정보를 요청합니다.
이름: 전체 이름을 입력합니다. Season of Docs는 이 이름을 오픈소스 조직과 공유하지 않으며 웹사이트에 이 이름을 게시하지 않습니다.
선택한 표시 이름: Docs 시즌에 참여하는 동안 공개 식별자로 사용할 이름을 제공합니다. 표시 이름으로 실제 실명을 사용하지 않는 것이 좋습니다. Season of Docs는 표시 이름을 신청서 양식에 명시한 오픈소스 조직과 공유합니다. Season of Docs는 웹사이트의 승인된 기술 문서 작성 프로젝트 목록에 내 표시 이름을 게시합니다.
이메일 주소: Google 계정과 연결된 이메일 주소를 입력합니다. (Google 계정이 있어야 Docs의 Season of Docs에 참여할 수 있습니다. Google 계정으로 Gmail이 아닌 이메일 주소를 사용할 수 있습니다. 이 도움말을 참고하세요.) Season of Docs는 이메일 주소를 사용하여 사용자와 소통하고 웹사이트 리소스를 제공합니다. Season of Docs는 이 이메일 주소를 신청 양식에 명시한 오픈소스 조직과 공유합니다. Season of Docs는 이 이메일 주소를 웹사이트에 게시하지 않습니다.
Season of Docs가 신청서 양식의 정보를 사용하는 방식에 대한 요약은 아래를 참조하세요.
기술 문서 작성 경험에 관한 정보
오픈소스 멘토와 조직 관리자는 프로젝트 제안서를 검토할 때 기술 문서 작성 경험에 관심이 있습니다. 다음과 같이 양식에 세부정보를 제공할 수 있습니다.
최근 기술 문서 작성 경험: 최근 기술 문서 작성 역할 또는 경력을 나열할 수 있는 최대 3개의 항목. 오픈소스 문서화 경험이 있다면 여기에도 포함하세요. 자신의 역할, 역할의 책임, 완료한 작업을 요약합니다. 해당하는 경우 날짜를 입력할 수 있습니다.
이력서 또는 CV 링크: (선택사항) 공개적으로 액세스할 수 있는 이력서 또는 교육과정 이력서 (CV) 버전의 URL.
작업 샘플 링크: (선택사항) 공개적으로 액세스할 수 있는 글쓰기 샘플 포트폴리오의 URL 또는 작품의 예시로 연결되는 개별 링크입니다.
추가할 정보: (선택사항) 이 애플리케이션에 추가하려는 모든 정보. 기술 문서에 대한 관심, Docs 시즌에 참여하려는 이유, 기타 관련 경험 등을 예로 들 수 있습니다.
프로젝트 제안서
프로젝트 제안서는 Docs 시즌 동안 선택한 오픈소스 조직과 함께 작업하면서 완료하고자 하는 문서 작업을 요약한 것입니다.
프로젝트 제안서는 최대 3개까지 제출할 수 있습니다. 모든 프로젝트 제안서는 동일한 신청서에 작성해야 합니다.
다음 가이드라인을 염두에 두고 프로젝트 제안서에 시간을 할애하세요.
준비 작업:
참여 중인 오픈소스 조직의 목록을 살펴보고 관심 있는 조직을 하나 이상 선택합니다. 선택한 각 오픈소스 조직이 제안한 프로젝트 아이디어를 살펴보세요.
관심 있는 조직에서 아이디어를 제안하지 않은 경우 프로젝트 아이디어의 일반적인 목록을 살펴보고 그중 하나를 바탕으로 아이디어를 생성할 수 있습니다. 조직에서 아이디어를 게시했는지 여부에 관계없이 나만의 아이디어를 생각해 낼 수도 있습니다
하나 이상의 참여 조직에 연락하여 프로젝트 아이디어에 대해 논의합니다. 연락하려면 참여 조직 목록에 표시된 조직의 이메일 주소를 사용합니다. 조기 토론은 좋은 프로젝트 제안을 작성하는 데 도움이 됩니다.
신청서 양식의 프로젝트 제안서:
오픈소스 조직 이름: Docs 시즌 동안 작업할 오픈소스 조직의 이름을 입력합니다. 이러한 조직은 Docs의 Season 웹사이트에 표시된 참여 조직 중 하나여야 합니다.
오픈소스 프로젝트 이름: Docs 시즌 동안 작업할 오픈소스 프로젝트의 이름입니다. 프로젝트는 Docs의 Season 웹사이트에 표시된 참여 조직 중 하나에 속해야 합니다. 일부 조직의 경우 조직 이름과 프로젝트 이름이 동일할 수 있습니다.
제안된 기술 문서 작성 프로젝트의 이름 제안하는 작업의 주요 목표를 요약하는 짧고 구체적인 제목을 제공합니다.
상세 설명 제안하는 기술 문서 작성 프로젝트에 관해 최대한 자세히 설명합니다. 설명 입력란에 여러 단락을 입력해도 됩니다. 다음은 포함할 내용에 관한 몇 가지 아이디어입니다.
- 생성/업데이트를 제안하는 문서의 세부정보를 제공합니다. 기존 문서 또는 사이트를 업데이트하려는 경우 링크를 포함하고 제안된 업데이트에 대해 설명합니다. 새 문서나 새 사이트를 제안하는 경우 콘텐츠와 대상을 설명합니다.
- 새로운 문서 또는 업데이트를 제안하는 이유를 설명합니다.
- 오픈소스 조직의 담당자와 프로젝트에 대해 논의한 경우 해당 토론의 결과를 요약하여 포함하세요.
- 제안서의 언어와 스타일에 주의를 기울이세요. 오픈소스 조직은 이를 제안 평가의 요소로 사용할 수 있습니다.
- 프로젝트 설명 링크는 제공하지 않습니다. 설명에는 프로젝트의 모든 결정적인 세부정보가 포함되어야 합니다. 오픈소스 조직은 다른 곳에 저장된 콘텐츠가 아닌 애플리케이션 양식의 콘텐츠를 기준으로 선택할 수 있어야 합니다. 설명을 보완하는 다른 콘텐츠로 링크해야 하는 경우에는 문제가 되지 않지만 신청서 양식의 내용만 프로젝트 선택에 사용된다는 점에 유의하세요.
신청서 양식의 기타 중요 입력란
다음은 신청 양식에 입력해야 하는 그 밖의 주요 정보에 관한 가이드라인입니다.
표준 길이 또는 장기 실행 프로젝트 선택: Docs 시즌의 문서 개발 단계의 표준 기간은 3개월입니다. 프로젝트에 더 오랜 시간이 필요한 경우 원하는 오픈소스 조직과 상의한 후 신청 양식에 이를 명시해야 합니다. 장기 실행 프로젝트 설명을 참조하세요.
Docs 시즌 지원금 수락: 테크니컬 라이터가 지원금을 받고 싶어하는 경우 Season of Docs는 프로젝트를 성공적으로 완료한 테크니컬 라이터에게 총금을 지급합니다. 기술 작성자 지원금 정보를 참조하세요. 지원금은 선택사항입니다. 지원금을 받지 않으려면 신청 양식에 선택 사항을 기재하세요.
Season of Docs가 신청서 양식의 정보를 사용하는 방식
이 섹션에서는 Season of Docs가 신청서 양식의 정보를 사용하는 방법을 요약합니다. 이 페이지의 이전 섹션에서는 주요 필드를 자세히 설명합니다.
표에는 주요 필드가 나와 있습니다. 각 필드의 경우 표는 문서 시즌의 다음 여부를 나타냅니다.
- 신청 양식에 지정한 오픈소스 조직에 정보를 전달합니다.
- Season of Docs 웹사이트의 승인된 기술 글쓰기 프로젝트 목록에 정보를 게시합니다.
| 양식에 대한 정보 | 오픈소스 조직과 공유하시겠습니까? | Docs의 시즌 웹사이트에 표시되나요? |
|---|---|---|
| 이름 | ||
| 표시 이름 | ||
| 이메일 주소 | ||
| 최근 테크니컬 라이팅 경험 | ||
| 이력서 또는 CV 링크 | ||
| 작업 샘플 링크 | ||
| 추가할 사항이 있는 경우 | ||
| 오픈소스 조직/프로젝트 이름 | ||
| 기술 문서 작성 프로젝트 이름 및 설명 | ||
| 장기 실행 프로젝트 또는 표준 길이 프로젝트 | ||
| 지원금 수령 |
위 표에서 사용된 기호의 핵심:
| 기호 | 기호의 의미 |
|---|---|
| 지원됨 | |
| No |
Notes
다음은 몇 가지 유의해야 할 사항입니다.
여러 프로젝트 제안서 제출: 두 개 이상의 프로젝트 제안서를 제출할 수 있지만 Season of Docs는 기술 작성자당 하나의 프로젝트 제안서만 허용합니다. 신청서 양식은 하나만 제출하실 수 있습니다. 양식에는 최대 3개의 프로젝트 제안서가 허용됩니다.
프로그램의 총 기술 글쓰기 프로젝트 수: Season of Docs는 총 일정 수의 기술 문서 작성 프로젝트만 수용할 수 있습니다. 슬롯 할당의 작동 방식을 알아보세요.
관련 가이드
테크니컬 라이터 제안서를 평가하는 방법은 멘토를 위한 힌트를 살펴보세요. 멘토 선정 기준을 이해하면 성공 가능성이 높은 제안서를 작성하는 데 도움이 됩니다.
Docs 시즌 애플리케이션을 제출하는 시기와 방법에 대한 절차 정보는 기술 작성자 가이드를 참조하세요.