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