이 페이지는 Cloud Translation API를 통해 번역되었습니다.

프로젝트 아이디어

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

프로젝트 아이디어는 테크니컬 라이터가 Docs가 진행되는 동안 멘토와 협업하여 작성할 수 있는 오픈소스 조직의 제안사항입니다.

이 페이지의 정보는 프로젝트 아이디어 목록을 준비하는 오픈소스 조직 관리자 및 멘토를 위한 것입니다. 이 정보는 조직의 Docs 시즌 참여에 대한 배경지식인 기술 작성자에게도 유용합니다.

프로젝트 예

다음은 테크니컬 라이터가 처리할 수 있는 프로젝트 유형에 대한 몇 가지 아이디어입니다.

테크니컬 라이터와 오픈소스 멘토가 결정할 수 있는 플랫폼에 문서 사이트를 구축하고 사이트에 초기 기본 문서 세트를 게시합니다. 플랫폼의 예는 다음과 같습니다.
- 문서 읽기
- Hugo, Jekyll, Sphinx 등의 정적 사이트 생성기
- GitHub 페이지
오픈소스 프로젝트의 기존 문서를 리팩터링하여 개선된 사용자 환경 또는 더 쉽게 액세스할 수 있는 정보 아키텍처를 제공합니다.
제품이나 기능의 개념적 개요나 소개를 작성합니다. 팀은 기술 문서를 아래에서 위로 작성하는 경우가 많으며, 그 결과 세부적인 내용은 많지만 제품을 전체적으로 이해하기 어렵습니다. 테크니컬 라이터가 이 문제를 해결할 수 있습니다.
주목받는 사용 사례를 위한 튜토리얼을 만드세요.
특정 작업에 초점을 맞춘 안내 가이드 모음을 만듭니다.
오픈소스 프로젝트의 기여자로 시작하는 방법에 관한 기본 정보는 물론 라이선스 계약, pull 요청 및 검토 프로세스, 프로젝트 빌드 등에 관한 규칙이 포함된 참여자 가이드를 만듭니다.

위의 아이디어는 범위와 크기가 의도적으로 다릅니다. 프로젝트에 소요되는 시간은 문서 세트의 크기, 제품의 복잡성, 기술 작성자 및 오픈소스 멘토의 경험, 오픈소스 프로젝트에서 제공하는 도구와 프로세스 등 다양한 요소에 따라 달라집니다.

위 목록의 목표는 처음 시작하는 것입니다. 다른 유형의 프로젝트도 제안할 수 있습니다.

프로젝트 아이디어를 공개 웹페이지, 블로그 게시물 또는 공개적으로 표시되는 기타 문서에 게시해야 합니다.

프로젝트 아이디어 페이지에는 다음 정보가 포함되어야 합니다.

오픈소스 조직에 관한 정보:
- 조직 이름
- 조직 설명
- 오픈소스 저장소 또는 웹사이트의 링크
- (선택사항) 조직에 Docs 시즌에 대해 문의할 수 있는 이메일 주소입니다. 이 주소는 조직의 Docs 시즌 신청 양식에 포함하는 이메일 주소와 동일해야 합니다.
- (선택사항) 표시 이름 등 조직 관리자 및 멘토에 대한 정보 이 이름은 조직의 Docs 시즌 신청 양식에 포함하는 표시 이름과 동일해야 합니다.
조직에서 올해 Docs 시즌 참여를 신청한다는 공지입니다. 프로모션 및 언론 페이지에는 문서 시즌에 대해 이야기할 때 사용할 수 있는 로고와 기타 콘텐츠가 포함되어 있습니다.
각 프로젝트 아이디어에 관해 아래에 설명된 정보를 포함한 프로젝트 아이디어

조직의 Docs Season용 애플리케이션을 만들 때는 프로젝트 아이디어 페이지 링크를 포함해야 합니다.

각 프로젝트 아이디어에는 최소한 다음 정보가 포함되어야 합니다.

프로젝트 이름: 간결하지만 설명이 포함된 제목을 선택합니다.
설명: 필요한 문서 작업에 관한 더 긴 설명입니다. 처음 떠오른 아이디어를 자세히 설명해 주세요. 관심 있는 테크니컬 라이터에게 아이디어를 확장하거나 다듬을 수 있는 기회를 제공하세요.
관련 자료:
- 문서가 필요한 오픈소스 프로젝트의 링크입니다.
- 기존 문서 세트의 업데이트가 포함된 기술 문서 작성 프로젝트를 제안하는 경우 해당 문서 세트에 연결합니다.
- 튜토리얼 또는 안내 가이드 모음을 제안하는 경우 문서화가 필요한 기능 또는 사용 사례를 설명합니다.
- 참여자 가이드를 제안하는 경우 기존 README 파일 또는 기타 관련 자료(있는 경우)로 연결합니다. 아직 사용할 수 있는 것이 없다면 말하는 것이 좋습니다
- 관련이 있는 경우 다른 프로젝트의 유사한 문서 링크를 포함합니다.

프로젝트 아이디어는 다음과 같은 여러 가지 면에서 중요합니다.

아이디어를 바탕으로 작업하면 조직에서 필요한 문서 작업을 체계화하고 테크니컬 라이터와 함께 작업할 수 있도록 준비할 수 있습니다.
프로젝트 아이디어를 통해 Google 프로그램 관리자는 테크니컬 라이터가 조직과 멘토링 관계를 맺을 때 다룰 업무 유형을 파악할 수 있습니다. Google 프로그램 관리자는 프로젝트 아이디어를 사용하여 Season of Docs에 참여하고 프로그램 전반에 걸쳐 테크니컬 라이터를 멘토링하겠다는 조직의 약속을 판단합니다.
프로젝트 아이디어는 관심 있는 테크니컬 라이터를 조직에 유치합니다. 제안된 프로젝트를 자체 프로젝트 제안서의 기반으로 사용할 수 있습니다.