테크니컬 라이터 가이드

현재 단계:
2019년 Docs 시즌 프로그램은 2020년 3월 6일에 종료되었습니다. 타임라인을 참고하세요.

이 페이지에는 Docs의 Season에 참여하는 테크니컬 라이터를 위한 가이드가 포함되어 있습니다.

소개

Docs 시즌에 오신 것을 환영합니다 이 가이드에서는 Docs 시즌에 참여하는 것에 관해 설명하고 프로그램의 각 단계에서 수행해야 할 활동을 안내합니다.

Docs 시즌에 참여할 수 있는 자격

테크니컬 라이터로서 Docs 시즌에 참여하려면 다음 요건을 충족해야 합니다.

  • 등록 당시 만 18세 이상이어야 합니다.
  • 역할 설명 및 작업 샘플을 제출하여 이전 기술 작성 경험이 있음을 보여줄 수 있습니다.
  • 프로그램 기간 동안 자신의 거주 국가에서 일할 수 있습니다.
  • 현재 미국이 금수 조치하지 않은 국가의 거주자입니다. 미국 재무부의 제재 프로그램 및 국가 정보를 참고하세요.

전체 작성자 기술 용어를 참조하세요.

오픈소스 멘토

Docs 시즌 멘토는 테크니컬 라이터가 아닐 수도 있으며 기술적 커뮤니케이션에 대한 경험이 거의 없을 수 있습니다. 훌륭한 문서의 가치를 알고 있으며 오픈소스 프로세스 및 도구에 대한 경험이 있는 오픈소스 조직의 구성원입니다.

나와 멘토 사이의 관계는 공동작업입니다. 문서 경험과 기술을 오픈소스 조직에 제공합니다. 멘토는 오픈소스 및 코드에 대한 지식을 제공합니다. 함께 기술 문서를 개발하고 오픈소스 프로젝트의 프로세스를 개선할 수 있습니다.

프로그램 공지 및 조직 신청 단계

Docs 시즌의 공지일은 2019년 3월 11일입니다. 관심 있는 오픈소스 조직은 2019년 4월 2일부터 2019년 4월 23일 사이에 Docs 시즌 참여를 신청할 수 있습니다. Google 프로그램 관리자는 2019년 4월 30일에 성공한 조직 목록을 게시합니다.

프로그램 발표 후 참여하는 오픈소스 조직을 게시하기 전까지 뉴스를 눈여겨보시기 바랍니다. 이 웹사이트로 돌아와서 웹에서 블로그 게시물이나 다른 뉴스를 볼 수도 있습니다. 일부 오픈소스 조직은 조직 적용 단계에서도 아이디어를 공유할 수 있습니다

또한 Docs Season of Docs와 이 프로그램에 관심이 있는 이유에 관해 널리 알려 주시기 바랍니다. 그래픽과 아이디어를 얻을 수 있는 홍보 자료를 살펴보세요.

테크니컬 라이터 탐색 단계

테크니컬 라이터 탐색 단계는 2019년 4월 30일부터 5월 28일까지 진행됩니다. 이 기간 동안 참여 조직 목록과 프로젝트 아이디어를 살펴볼 수 있습니다.

관심 있는 프로젝트를 하나 이상 찾았다면 관련 오픈소스 조직에 직접 연락하여 프로젝트 아이디어를 논의해야 합니다.

이 단계에서 테크니컬 라이터로서의 작업

참여 오픈소스 조직의 목록과 프로젝트 아이디어를 살펴보세요.

목록을 살펴보고 작업할 오픈소스 조직을 찾습니다. 조직에서 제안한 기술 문서 작성 프로젝트를 살펴보고 어떤 프로젝트가 적합한지 결정하세요. 둘 이상의 조직에 신청할 수 있습니다. 현재 Docs 시즌 단계에서 두 개 이상의 옵션을 살펴보는 것이 좋습니다. 최종 선택 프로세스에서는 테크니컬 라이터당 하나의 프로젝트만 허용됩니다.

참여 오픈소스 조직

오픈소스 조직과 프로젝트 아이디어를 논의해 보세요.

참여 조직과 프로젝트 아이디어를 논의할 수 있습니다. 연락하려면 참여 조직 목록에 표시된 조직의 이메일 주소를 사용하세요. 조기 토론을 통해 테크니컬 라이터 신청 단계에서 Google 프로그램 관리자에게 제출할 수 있는 적합한 프로젝트 제안서를 작성할 수 있습니다. 초기 프로젝트 아이디어는 조직에서 제안한 아이디어 목록에서 가져올 수 있습니다. 나만의 아이디어를 제안할 수도 있습니다.

참여 오픈소스 조직

기술 글쓰기 프로젝트를 위한 아이디어

테크니컬 라이터 신청 단계

테크니컬 라이터 신청 단계는 2019년 5월 29일부터 2019년 6월 28일까지 진행됩니다. 이 기간 동안 Docs 시즌 참여를 신청할 수 있습니다. Google 프로그램 관리자는 애플리케이션의 관련 세부정보를 개발자가 선택한 오픈소스 조직으로 전달합니다. 그런 다음 오픈소스 조직 관리자 및 멘토가 멘토링할 프로젝트를 선택합니다.

이 단계에서 테크니컬 라이터 신청자로서 해야 할 일

Season of Docs에 참여할 수 있도록 지원서를 제출하세요.

2019년 6월 28일 전에 Docs Season 지원서를 제출하세요.

애플리케이션 만들기

Docs 2019 시즌 테크니컬 라이터 신청이 마감되었습니다.

커뮤니티 유대감 단계

커뮤니티 유대감 형성 단계는 2019년 8월 7일부터 9월 1일까지입니다. 이 기간 동안 오픈소스 멘토의 도움을 받아 오픈소스 프로젝트와 커뮤니티에 익숙해질 수 있습니다.

이 단계에서 테크니컬 라이터로서의 작업

커뮤니케이션 채널을 설정합니다.

협업하기로 선택한 오픈소스 조직의 멘토와 연락합니다. 멘토 및 조직 관리자와 직접 커뮤니케이션할 수 있는 안정적인 방법을 마련해야 합니다. 조직 관리자는 오픈소스 조직의 주요 연락처 역할을 하는 오픈소스 조직의 구성원입니다.

귀하의 책임

멘토의 책임

테크니컬 라이터와의 협업을 위한 멘토 가이드

오픈소스 프로젝트 및 커뮤니티에 참여하세요.

오픈소스 조직에서 사용하는 도구와 프로세스에 대해 멘토에게 질문하세요. 오픈소스 커뮤니티의 메일링 리스트, 채팅, Slack 채널, 기타 공유 커뮤니케이션 채널에 자신을 소개하세요.

제품을 전체적으로 파악합니다.

멘토에게 앞으로 문서화할 제품 (특히 개념적)에 대해 설명하도록 요청합니다. 문서의 대상에 대해 자세히 논의합니다.

목표 및 기대치를 설정합니다.

멘토와 함께 기술 문서 작성 프로젝트의 목표를 다듬고 양측의 기대치를 설정합니다. 지금 이러한 목표와 기대치를 설정하는 것은 프로젝트의 성공을 보장하는 좋은 방법입니다.

문서 개발 단계

문서 개발 단계는 2019년 9월 2일부터 2019년 11월 22일까지 진행됩니다. 장기 실행 프로젝트의 종료일은 다릅니다. 이 기간 동안 멘토와의 긴밀한 협의를 통해 프로젝트 작업을 진행합니다.

이 단계에서 테크니컬 라이터로서의 작업

멘토와 함께 프로젝트를 완료하세요.

멘토와 긴밀하게 협력하여 프로젝트를 완료합니다. 오픈소스 커뮤니티의 절차에 따라 결과 문서에 대한 검토를 요청하고 오픈소스 저장소에 업데이트를 제출합니다. 예를 들어 GitHub에서 호스팅되는 오픈소스 프로젝트는 검토 및 제출을 위한 pull 요청을 만들어 파일을 추가하거나 업데이트합니다.

조직 관리자에게 우려사항을 제기합니다.

멘토와의 커뮤니케이션이 우려되거나 프로젝트를 성공적으로 완료하는 데 영향을 미칠 수 있는 다른 문제가 발생할 경우 오픈소스 조직 관리자에게 알려주세요.

귀하의 책임

Google 프로그램 관리자의 설문조사에 참여합니다.

Google 프로그램 관리자가 진행 상황을 평가하기 위해 프로젝트 중간에 설문조사를 보낼 수 있습니다. 설문조사 문서의 안내에 따라 설문조사를 완료하고 답변을 Google 프로그램 관리자에게 제출하세요.

프로젝트 완료 및 평가 단계

프로젝트 완료 단계는 2019년 11월 25일부터 29일까지, 평가 단계는 2019년 11월 25일부터 12월 6일까지입니다. 장기 실행 프로젝트의 경우 날짜가 다릅니다. 프로젝트 완료 기간 동안 최종 작업 제품이라고도 하는 프로젝트 보고서를 제출합니다. 평가 단계에서는 멘토에 대한 평가와 Docs Season of Docs의 참가자로서의 경험에 대한 평가를 제출합니다.

이 단계에서 테크니컬 라이터로서의 작업

프로젝트 보고서를 작성합니다.

프로젝트 보고서 (업무용 제품이라고도 함)를 작성합니다. 프로젝트 보고서에는 문서 시즌 동안 수행한 작업에 대한 설명과 관련 링크가 포함됩니다.

프로젝트 보고서 만들기

2019년 Docs 시즌 프로젝트 완료 단계가 종료되었습니다.

멘토에게 프로젝트 보고서를 검토해 달라고 요청하세요.

멘토가 내 성과를 설명하는 방법에 대한 소중한 정보를 제공할 수도 있습니다. 또한 멘토가 프로젝트의 완료 여부를 표시하기 전에 이 단계에서 프로젝트 상태를 공동으로 이해하는 것이 유용합니다.

프로젝트 보고서를 마무리합니다.

2020년 2월 28일 18:00(UTC)까지 프로젝트 보고서를 마무리하세요. 양식은 수정할 수 있지만 지정된 날짜까지 최종 버전을 제출해야 합니다.

2019년 Docs 시즌 프로젝트 완료 단계가 종료되었습니다.

멘토에 대한 평가와 Docs Season of Docs 사용 경험을 작성하여 제출합니다.

2020년 2월 28일 18:00(UTC)까지 평가를 완료하여 제출하세요.

테크니컬 라이터별 평가

귀하의 책임

2019년 Docs 시즌 프로젝트 완료 단계가 종료되었습니다.

장기 실행 프로젝트

Docs 시즌의 표준 길이 기술 글쓰기 프로젝트의 경우 문서 개발 단계는 2019년 9월 2일부터 2019년 11월 22일까지 진행됩니다. 하지만 일부 테크니컬 라이터는 오픈소스 조직과의 협의를 거쳐 장기 실행 프로젝트를 신청할 수 있습니다. 장기 실행 프로젝트의 문서 개발 단계는 2019년 9월 2일부터 2020년 2월 21일까지 진행됩니다.

장기 실행 프로젝트의 프로젝트 완료 및 평가 기간은 2020년 2월 24~28일입니다.

개발자의 작업 및 책임은 이 페이지에 설명된 표준 길이 기술 문서 작성 프로젝트와 동일합니다. 단, 프로젝트 완료 및 평가 날짜는 이후 날짜입니다.