현재 단계:
2021년 Season of Docs 프로그램은 2021년 12월 14일에 종료되었습니다. 타임라인을 참고하세요.
이 가이드를 템플릿으로 사용하여 조직의 프로젝트 제안서를 작성하세요.
PROPOSAL TITLE - organization name(제안서 제목 - 조직 이름)
제안서 제목은 짧고 구체적이어야 합니다. 'ORGNAME 참여자 가이드 업데이트'는 좋은 제안서 제목입니다. '문서 개선'은 너무 모호하고 '참여자 가이드 5,7,23,99 섹션 업데이트, FAQ 만들기, 스타일 가이드 만들기'는 너무 길다.
조직 정보
이 섹션에서는 조직 또는 프로젝트에 대해 간단히 설명해 주세요. 프로젝트에서 해결하려는 문제는 무엇인가요? 사용자와 참여자는 누구인가요? 조직 또는 프로젝트가 설립된 지 얼마나 되었나요? 제안서에 자금을 지원하면 오픈소스와 전 세계에 긍정적인 영향을 미칠 수 있는 이유를 설명해 주세요.
GloriousPickle (현재 버전 1.2.3, 2009년 첫 출시)은 MIT 라이선스를 받은 라이브러리로, 소금, 설탕, 식초, 향신료를 적절한 비율로 쉽게 계산하여 모든 피클용 야채에 사용할 수 있습니다. 계산할 수 있는 양은 1개의 어린 오이부터 컨테이너 한 가득의 무까지 다양합니다. 참여자는 전 세계의 피클 애호가이며 사용자는 홈 셰프, 레스토랑 셰프, 대규모 식품 가공 회사 및 조직의 물류 담당자입니다. 가장 큰 사용자는 푸드뱅크에서 유통기한이 짧은 채소를 안정적인 피클 병으로 만들어 많은 지역사회의 배고픈 사람들을 먹이고 음식물 쓰레기를 줄이는 데 도움을 주는 조직입니다. 또한 사용자는 GloriousPickle 사용에 관한 선택적 측정항목을 Google에 전송합니다. Google은 이 측정항목을 사용하여 머신러닝을 통해 새로운 피클 레시피를 만드는 대규모 데이터 세트인 PickleSet을 생성합니다.
프로젝트 정보
프로젝트 문제
프로젝트에서 해결할 문제를 알려주세요. 이 문제를 해결하는 것이 조직 또는 프로젝트에 중요한 이유는 무엇인가요?
사용자는 GloriousPickle 도구에 새로운 향신료 및 기타 재료 (특히 유럽 이외의 요리 재료)에 관한 정보를 추가하고 싶어 합니다. 안타깝게도 이 정보를 추가하는 절차가 잘 문서화되어 있지 않아 잠재적인 참여자가 도움을 받으려면 프로젝트에서 문제를 열어야 하거나 아예 포기하는 경우가 많습니다. 또한 이 절차에서는 많은 사용자가 전문 개발자가 아니지만 참여자가 이미 풀 리퀘스트 절차와 GitHub에 익숙하다고 가정합니다.
재료 정보가 많을수록 GloriousPickle이 모든 사용자에게 더 유용해집니다.
프로젝트 범위
조직에서 만들거나, 업데이트하거나, 개선할 문서에 관해 알려주세요. 일부 작업이 의도적으로 수행되지 않는 경우 해당 정보도 포함하세요. 예상 소요 시간과 프로젝트에 참여할 조직 자원봉사자 및 기술 작가를 이미 찾았는지 여부를 포함합니다.
GloriousPickle 프로젝트 (코드명: PicklePlus)는 다음을 수행합니다.
- 기존 문서를 감사하고 세 가지 주요 사용 사례 (새로운 재료 추가, 변형 재료 추가, 재료에 관한 정보 업데이트 또는 수정)에 대한 현재 문서의 불편사항 로그를 만듭니다.
- 문서의 공백을 파악하기 위한 가이드로 불만사항 로그를 사용하여 주요 사용 사례에 관한 업데이트된 문서를 만듭니다.
- pull 요청 및 GitHub를 처음 사용하는 참여자가 Google의 절차를 사용할 수 있도록 지원하는 빠른 '요약본'을 만듭니다.
- 문서 테스터 (프로젝트의 자원봉사자) 및 광범위한 GloriousPickle 커뮤니티의 의견을 반영합니다.
- 출시팀과 협력하여 GloriousPickle 사이트의 문서를 업데이트하고 향후 문서를 업데이트 도구와 동기화하는 프로세스를 만듭니다.
이 프로젝트의 지원 범위에 해당하지 않는 작업:
- 이 프로젝트는 동일한 성분의 다른 철자 또는 이름 간에 교차 연결하는 프로세스를 만들지 않습니다.
- 이 프로젝트에서는 GitHub 튜토리얼을 만들지 않습니다. 대신 요약본은 관련성 있고 유용한 기존 자료로 연결됩니다.
이 프로젝트에 적합한 기술 문서 작성 후보가 2명 있으며, 이 작업을 완료하는 데 3개월이 소요될 것으로 예상됩니다. GloriousPickle PickleDocs SIG와 @GloriousPicklePat (ingredient-adding API의 핵심 유지관리자)이 프로젝트를 지원하기로 약속했습니다.
프로젝트 성공 측정
새 문서가 문제 해결에 도움이 되었는지 어떻게 알 수 있나요? 어떤 측정항목을 사용하고 어떻게 추적할 계획인가요?
GloriousPickle은 분기에 평균 10개의 풀 리퀘스트를 받습니다. 이 풀 리퀘스트는 새로운 재료('ingredient' 태그)를 추가하거나 업데이트하기 위한 것입니다. 이러한 풀 리퀘스트의 대부분(60% 이상)은 이전 참여자의 요청입니다. 문서가 개선되면 풀 리퀘스트가 늘어나고 신규 참여자의 풀 리퀘스트도 늘어날 것으로 기대합니다. 활발한 참여자의 대부분은 재료를 추가하는 것으로 시작했기 때문에 이 문서를 개선하면 전반적으로 더 많은 참여자가 생겨날 것으로 생각합니다.
문서가 게시된 후 매월 두 가지 측정항목 (구성요소 관련 풀 리퀘스트 수 및 신규 참여자의 풀 리퀘스트 수)을 추적합니다. 또한 문서가 게시된 후 분기별로 전체적으로 3회 이상 참여한 참여자 수를 추적할 예정입니다.
새 문서가 게시된 후 다음과 같은 경우 프로젝트가 성공했다고 간주됩니다.
- 구성요소 관련 풀 요청 수가 20% 증가함
- 신규 참여자의 풀 리퀘스트 수가 15% 증가합니다.
- 3회 이상 참여한 참여자 수가 10% 증가합니다(문서가 게시된 후 분기부터 적용).
프로젝트 예산
일반 가이드라인
- 제안서에 예산을 포함하거나 별도의 링크로 연결할 수 있습니다. 예산이 10개 미만인 경우 제안서에 포함하는 것이 좋습니다.
- 모든 예산은 미국 달러로 표시해야 합니다. 예상되는 보조금은 미화 5,000~15,000달러입니다. 프로젝트가 이 범위를 벗어나는 경우 예산을 정당화하는 추가 정보를 제공해 주세요.
- 예산의 대부분 (최소 60~70%)은 프로젝트에 참여하는 기술 작가에게 할당될 것으로 예상됩니다. 가능하면 프로젝트별로 예산을 책정하는 것이 좋습니다.
- 오픈소스 프로젝트는 가능하면 항상 오픈소스 도구를 사용해야 합니다. 프로젝트에 독점 소프트웨어 라이선스 또는 지원을 위한 자금이 절대적으로 필요한 경우 금액에 대한 근거를 포함하세요.
- 기타 가능한 비용은 다음과 같습니다.
- 문서 사이트의 브랜딩, 로고, 템플릿 또는 기타 디자인 저작물을 만드는 디자인 작업
- 프로젝트 상품(참여자용 티셔츠 또는 스티커)의 최소 금액 (미화 200달러 미만) Season of Docs 로고를 사용하는 경우 프로젝트 또는 조직 로고 또는 이름과 함께 사용해야 합니다. 혜택에는 Google 이름을 사용할 수 없습니다.
- 프로젝트에서 상당한 멘토링 또는 안내 역할을 하는 자원봉사자를 위한 최소한의 보조금 (자원봉사자당 500달러 이하 권장)
- 다른 오픈소스 프로젝트에 대한 다운스트림 기부는 총 예산의 10% 를 초과해서는 안 됩니다.
- 필요한 경우 다른 예산 항목과 함께 요청 금액에 대한 근거를 포함합니다. 비용의 타당성은 지출이 프로젝트 전체의 성공에 어떻게 기여할지 강조해야 합니다.
샘플 예산
| 예산 항목 | 금액 | 누계 | 메모/근거 |
|---|---|---|---|
| 기술 작가가 GloriousPickle의 재료 추가 절차에 관한 새 문서를 감사, 업데이트, 테스트, 게시합니다. | 5000.00 | 5000.00 | |
| 자원봉사자 수당 | 500 | 6500.00 | 자원봉사자 수당 3개 x 각 500달러 |
| 프로젝트 티셔츠 (티셔츠 10개) | 150.00 | 6650.00 | |
| 거대한 공기주입식 유니콘 (4.5m 버전) | 99.99 | 6749.99 | 프로젝트 개발 기간 동안 기술 작가의 질문에 가장 빨리 답변한 팀에 풍선 유니콘을 제공합니다. |
| 합계 | 6749.99 |
추가 정보
제안서와 관련된 추가 정보를 여기에 포함하세요.
기술 문서 작성자 또는 문서 관련 이전 경험: 본인 또는 멘토가 이전에 기술 문서 작성자와 협력했거나 문서를 개발한 적이 있다면 신청서에 이를 언급하세요. 작성한 문서와 기술 작가와 협력한 방식을 설명합니다. 예를 들어 사용한 검토 프로세스나 기술 문서 작성자의 기술이 프로젝트에 어떻게 유용했는지 설명하세요. 이러한 이전 경험이 Google Season of Docs에서 테크니컬 라이터와 협업하는 데 어떤 도움이 될 수 있는지 설명합니다.
이전 시즌 오브 문서, Google 프로그래밍 경진대회(Summer of Code) 또는 기타 프로그램 참여: 본인 또는 멘토가 Google 프로그래밍 경진대회(Summer of Code) 또는 유사한 프로그램에 참여한 적이 있다면 신청서에 이를 명시하세요. 해당 프로그램에서 거둔 성과를 설명합니다. 이 환경이 Google Docs 시즌에 어떤 영향을 미칠 수 있는지 설명합니다.