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