현재 단계:
결과 발표. 타임라인을 참고하세요.
이 예시를 사용하여 자체 우수사례 보고서를 작성하세요.
PicklePlus: GloriousPickle 참여 도구 문서화
조직 또는 프로젝트: Glorious Pickle 조직 또는 프로젝트의 기본 사이트 링크
조직 설명: GloriousPickle (최신 버전 1.2.3, 2009년 첫 출시)은 모든 절임 가능한 채소에 소금, 설탕, 식초, 향신료의 완벽한 비율을 손쉽게 계산할 수 있는 MIT 라이선스 라이브러리로, 오이 한 마리부터 컨테이너 선박에 이르기까지 다양한 수량으로 쉽게 계산할 수 있습니다.
저자: 선택사항: 우수사례의 저자를 기재하고 요청 시 사용자 이름 사용
문제 기술서/제안 개요
새롭거나 개선된 문서로 어떤 문제를 해결하려고 하셨나요? 가능한 경우 프로젝트 사이트의 제안 페이지로 연결합니다.
GloriousPickle 도구 요소 데이터베이스에 재료를 추가하는 작업은 시간이 오래 걸리고 복잡하며 도구에는 양질의 문서가 없습니다. git을 사용하거나 pull 요청을 보낸 경험이 없는 참여자가 많습니다. 즉, GloriousPickle은 성분 데이터에 심각한 격차가 있고 도구의 유용성을 떨어뜨립니다. 새로운 재료 추가에 관한 문서를 개선하여 새로운 참여자와 더 많은 피클링을 장려하고자 합니다!
프로젝트 설명
제안서 만들기
Google Docs 시즌 제안서를 어떻게 준비하셨나요? 조직에서 아이디어를 결정하기 위해 어떤 절차를 사용했나요? 어떻게 의견을 구하고 반영했나요?
GloriousPickle PickleDocs SIG는 Google Open Source Programs Office의 트윗을 통해 Google Season of Docs 프로그램에 대해 알게 되었습니다. SIG는 격주 회의에서 이 프로그램에 대해 논의했으며 제안서를 작성하는 데 동의했습니다. SIG의 멤버 2명 (@KimChiCook 및 @Dillicious)은 다음 회의에서 검토할 제안서 초안 작성에 자발적으로 참여했습니다.
PickleDocs SIG가 제안서 초안에 동의하면 의견을 요청하는 이메일이 전체 프로젝트에 전송되었습니다. ingredient-adding API의 유지관리 담당자인 @GloriousPicklePat을 포함해 14명의 커뮤니티 회원이 의견을 제공했습니다. @GloriousPicklePat는 이 프로그램이 진행되는 동안 자원봉사자가 되었습니다.
접수된 의견을 논의하고 반영한 후 제안서를 GloriousPickle 프로젝트 운영 위원회에 보내 투표했습니다. GPPSC의 회원 5명 모두가 제안서 및 신청서 제출에 +1을 했고, @VinegarViv는 프로그램에 참여하고 지급을 감독하는 데 필요한 Open Collective 계정을 만드는 데 도움을 주기로 동의했습니다.
예산
예산에 간단한 섹션을 포함합니다. 작업을 어떻게 추정하셨나요? 예상치 못한 비용이 발생했나요? 보조금 지원금보다 지출액이 줄었나요? 자금을 적절하게 할당했나요, 아니면 일부 항목을 더 많이/적거나 불필요하게 할당했나요? Google Docs 시즌 외에 사용할 수 있는 다른 자금이 있었나요?
GloriousPickle PickleDocs SIG에는 유럽과 아르헨티나에서 1명씩 테크니컬 라이터로 활동했습니다. 그들은 작업을 추정하고 유사한 프로젝트 예산을 찾아서 이전에 완료한 제안서 초안 작업을 비교하는 데 도움이 되었습니다. 또한 프로젝트에 할당한 2019 PicklePals 컨벤션에서 받은 무제한 스폰서십(US$1,000)이 남은 상태였습니다.
산불의 영향을 받는 지역에 거주하고 있고 집에서 인터넷을 사용할 수 없는 테크니컬 라이터가 Wi-Fi 핫스팟을 임대하는 데 예상치 못한 비용이 발생했습니다. 또한 참가자들에게는 계획보다 적은 티셔츠를 발송하게 되어 균형이 잘 잡혔습니다.
또한 Google은 GloriousPickle 기고자인 @Piccalily (피클링을 하지 않는 일상에서 전문 카피 편집자였던 분)에게 테크니컬 라이터가 작성한 문서의 카피편집과 교정을 지원하기로 했습니다.
참여자
프로젝트에 참여한 사람은 누구인가요 (참가자가 요청하는 경우 사용자 이름 사용)? 테크니컬 라이터를 어떻게 찾고 고용했나요? 다른 자원봉사자나 유료 참여자를 어떻게 찾으셨나요? 어떤 역할을 맡았나요? 중도 포기한 사람이 있나요? 채용, 커뮤니케이션, 프로젝트 관리에 대해 무엇을 배웠나요?
이 프로젝트를 진행한 핵심 팀은 다음과 같습니다.
- @Dillicious, @KimChiCook (PickleDocs SIG)
- @Piccalily (copyeditor)
- @GherKen, @VinegarViv (관리자 도움말, GPPSC)
- @BBChips, @GloriousPicklePat (주제 전문가)
- Sam Scribe (테크니컬 라이터)
Google Season of Docs GitHub 저장소 목록에서 샘 스크리브를 찾았습니다. 우리는 그들의 경험 (샘은 요리 잡지에서 일하고 웹사이트 문서 작성도 한 경험이 있음)이 우리 프로젝트와 잘 부합한다고 생각했습니다. 격주로 진행되는 PickleDocs SIG 통화에 참가하여 프로젝트에 관해 대화를 나누면서 몇 가지 매우 가치 있는 제안을 제안에 반영했습니다. 또한 SIG 회원의 네트워크를 통해 알고 있는 2명의 다른 테크니컬 라이터에게 연락을 드렸으나, 프로그램 기간 동안에는 둘 다 참석할 수 없었습니다.
샘의 시간대는 PickleDocs SIG 회원 대부분과 몇 시간만 겹치기 때문에 토론 포럼에 샘의 시간대에 거주하고 재료 추가 과정에 익숙한 선택자를 위해 토론 포럼에 전화를 걸었습니다. @BBChips는 자발적으로 샘에게 질문에 답하고 필요에 따라 다른 전문가를 찾는 데 도움을 주었습니다. 또한 @GloriousPicklePat는 샘이 도구의 기본 아키텍처와 API에서 발생할 수 있는 오류 메시지를 이해하는 데 자발적으로 참여하고 GitHub 및 git 도움말도 제공했습니다.
안타깝게도 프로그램 도중에 @VinegarViv는 개인적인 이유로 프로젝트를 그만두어야 했습니다. GPPSC 회원인 @GherKen은 관리 및 지급 관련 문제를 처리하기 위해 발을 디뎠습니다.
일부 놓친 질문 (GloriousPickle는 무료 Slack 인스턴스를 사용하고 있지만 토론이 너무 빨리 진행되어 롤링 보관처리 제한으로 인해 대화가 끊긴 경우도 있음) 후 진행 중인 질문 목록을 공유 문서에 보관해야 한다는 것을 알게 되었습니다 (공유 Google 문서 사용). PickleDocs SIG 회원은 각 회의 전에 이를 확인하고 회의가 끝나기 전에 답변을 받았습니다. 샘은 긴급한 질문을 위해 @BBChips를 직접 핑할 수 있었습니다.
샘과 샘과 함께 작업하면서 매우 만족스러웠습니다. GloriousPickle 문서를 업데이트하는 것 외에도 샘와 샘 덕분에 열광적인 선택자가 되었습니다.
타임라인
프로젝트 일정을 간략하게 설명합니다 (프로젝트가 진행 중인 경우 예상 종료일 또는 중간 마일스톤 표시).
Google Season of Docs 프로그램이 참여 조직을 발표하기를 기다리는 동안 PickleDocs SIG 회원들은 샘에게 유용할 것으로 생각되는 이전 작업을 검색했습니다. 한 달 동안 중단되었던 문서를 업데이트하려는 이전 노력에서 나온 몇 가지 메모를 찾았으며 Google 오픈소스 저장소에 있는 문서 성숙도 감사 자료의 일부도 검토했습니다.
Google 문서 시즌에 선정되었다는 좋은 소식을 받아본 후, Sam과 PickleDocs SIG는 서로 만나 대략적인 일정을 세웠습니다.
| 단계 | 완료자 |
|---|---|
| 문서 감사 검토 | 5월 7일 |
| 마찰 로그 3 사용 사례 | 5월 14일 |
| @GloriousPicklePat 및 @BBChips를 사용해 마찰 로그를 검토하고, 쿼리에 답하세요 | 5월 28일 |
| 업데이트된 문서 사용 사례 1의 초안 | 6월 25일 |
| @GloriousPicklePat 및 @KimChiCook 검토자 사용 사례 1 초안 | 7월 2일 |
| 업데이트된 문서 사용 사례 2의 초안 | 7월 2일 |
| @GloriousPicklePat 및 @Dillicious가 검토한 사용 사례 2 초안 | 7월 9일 |
| 업데이트된 문서 사용 사례 3의 초안 | 7월 9일 |
| @Dillicious와 @KimChiCook의 사용 사례 3 초안 검토 | 7월 16일 |
| 모든 사용 사례에서 답변된 모든 쿼리 | 7월 30일 |
| 특정 PickleDocs SIG 대부분을 8월 1~20일에 휴가 중이었습니다. | -- |
| 커뮤니티에서 새 문서 (GloriousPickle 사이트에 초안으로 게시된 문서) 테스트를 시작합니다. | 8월 21일 |
| 테스트 의견 통합됨 | 9월 10일 |
| 새 문서의 사본 편집 및 교정 | 9월 17일 |
| 문서의 초안 상태 삭제됨, 문서 공식 출시 | 9월 28일 |
| 생성된 문서를 업데이트하는 프로세스 | 11월 1일 |
| 이 우수사례는 | 11월 8일 |
| 우수사례 제출됨 | 11월 16일 |
제안서 예산에서는 테크니컬 라이터가 프로젝트 작업에 주당 10~15시간을 소비할 것으로 예상했습니다. 사용 시간 기록을 보관했으며 주당 평균 11.5시간을 기록했습니다.
결과
어떤 내용이 생성, 업데이트 또는 변경되었나요? 가능한 경우 게시된 문서의 링크를 포함합니다. 제안서에 생성되지 않은 결과물이 있었나요? 해당 항목도 나열합니다.
세 가지 주요 사용 사례가 전체 사용자 안내 가이드와 함께 문서화되어 있습니다.
GloriousPickle에 새 재료를 추가하는 방법
GloriousPickle에 변형 재료를 추가하는 방법
GloriousPickle에서 재료를 업데이트하거나 수정하는 방법
이 가이드에는 참여를 더 쉽게 할 수 있는 새로운 pull 요청 템플릿도 포함되어 있습니다.
또한 프로젝트를 진행하는 동안 샘은 학습한 용어를 정리한 작은 Pickle 용어집을 만들었는데 GloriousPickle 프로젝트 사이트에도 게시되었습니다.
프로젝트 위키에 사용자 안내 가이드를 업데이트하는 방법을 추가했습니다.
Google에서는 GitHub에 새로 참여한 참여자의 프로세스와 도구 사용을 돕기 위해 요약본을 만드는 작업을 포함했지만, 사용 가능한 리소스를 확인한 후 다른 프로젝트의 요약본을 포크할 수 있었습니다.
측정항목
프로젝트의 성공을 측정하기 위해 어떤 측정항목을 선택했나요? 이러한 측정항목을 수집할 수 있었나요? 측정항목이 프로젝트에 대해 원하는 결과와 연관성이 있나요? 제안 이후 측정항목이 변경되었나요?
제안서에서는 두 가지 측정항목을 제안했습니다.
- 재료 관련 pull 요청 수
- 새 참여자의 pull 요청 수
9월 (문서 초안 게시 후 첫 한 달)에는 재료 관련 pull 요청이 5% 증가했고 (8월에는 20개에서 9월 21일로) 새로운 참여자는 총 4회를 기록했습니다 (8월에 2건의 새로운 참여자를 제출한 새로운 참여자 2명 대비). 이러한 측정항목을 매달 추적할 계획입니다.
또한 1월 1일부터는 문서가 게시된 후 분기별로 3회 이상 참여한 참여자의 수를 추적할 예정입니다.
일례로, 이 새로운 문서는 새로운 기여자가 GloriousPickle 재료 데이터베이스에 추가할 수 있도록 하는 데 큰 역할을 했다고 생각합니다. 한 명의 새로운 기여자는 이전에 시도했지만 프로세스를 이해하지 못해 업데이트를 완료하지 못했다고 PR 댓글에서 언급했습니다.
분석
어떤 점이 마음에 드셨나요? 예상치 못한 사항 어떤 장애물이나 차질을 겪었나요? 프로젝트가 성공적이라고 생각하십니까? 그 이유는 무엇인가요? (조금 아직 이르지 않는다면 프로젝트의 성공 여부를 판단할 수 있을 것으로 예상되는 시기를 설명하세요.)
Google의 Docs 시리즈 프로젝트가 거둔 결과에 매우 만족하고 있으며 성공적인 프로젝트라고 생각합니다. 새로운 문서는 명확하고 유용하며, 요소 관련 pull 요청 수와 새로운 참여자의 pull 요청 수가 이미 늘고 있습니다.
또한 거의 모든 GloriousPickle 커뮤니티가 원래 제안에 대한 의견을 제공하고 새 문서를 초안 형태로 테스트하는 방법으로 참여해서 기뻤습니다.
우리는 몇 가지 예상치 못한 장애물에 직면했습니다. 우리는 샘 주에서 발생한 산불이 인터넷 중단보다 더 많은 피해를 야기하지 않았다는 점에 감사했습니다! 또한 프로젝트에서 @VinegarViv를 잃어 아쉽습니다. 그녀와 가족의 행복을 기원하며 곧 다시 만나기를 바랍니다.
샘이 이 문서 작업을 시작하기 전까지는 몰랐습니다. 하지만 샘은 생소한 모든 용어를 목록으로 작성하고 직접 조사한 후 커뮤니티 회원에게 설명과 참고 자료를 요청하여 용어를 정의했습니다. 이 Pickle 용어집은 앞으로 피클 커뮤니티로 더 많은 사람들을 환영하는 데 큰 도움이 될 것입니다.
요약
프로젝트 경험을 2~4문장으로 요약하세요. 알게 된 점과 앞으로 어떻게 할 것인지 강조합니다. 문서로 유사한 문제를 해결하려는 다른 프로젝트에 어떤 조언을 하고 싶으신가요?
한마디로, 우리는 무서운 경험을 했습니다! 문서 결과물을 달성하고 측정항목이 목표에 부합하는 것 같습니다.
이 프로젝트가 성공할 수 있었던 데 크게 기여한 것은 테크니컬 라이터인 Sam Scribe와 함께 작업했다는 점입니다. [작성하지 않음 - 샘] 샘은 피클링이나 GitHub에 대한 경험이 없지만 숙련된 테크니컬 라이터로서 새로운 분야를 배우고, 질문하고, 연구하는 데 익숙했습니다. 샘은 프로젝트 도구 (간반 보드를 사용하여 작업 추적)뿐 아니라 웃음을 터뜨리기도 했습니다. 샘이 피클링 곤충을 잡았고 커뮤니티에 '병에 넣은' 것을 매우 기쁘게 생각합니다.
다른 프로젝트에는 다음과 같이 하는 것이 좋습니다.
- 제안서는 작고 관리하기 쉬워야 합니다. (원래는 산업용 일괄 절임 기계와 함께 에스티메이터를 사용하는 것에 대한 문서를 제안서에 포함하기로 했지만, 오픈소스 피클 기계에 깊이 관여하는 커뮤니티 회원 중 한 명이 프로그램 기간 동안 박사 논문을 작성할 예정이기 때문에 생략했습니다.) 결국에는 샘을 바쁘게 보낼 만큼 해야 할 일도 많았습니다.
- 테크니컬 라이터를 찾을 때 네트워크를 활용하세요. 커뮤니티의 모든 사용자에게 추천을 요청하세요. Docs GitHub의 Google 시즌을 통해 Sam을 찾았지만 신청 기간 동안 여러 사람과 대화를 나누었기 때문에 자신 있게 작업할 수 있었습니다.
- 테크니컬 라이터로서 커뮤니티에 오신 것을 환영합니다. 샘은 GloriousPicklers의 열정적인 태도로 질문을 쉽게 할 수 있었다고 말합니다.
- 테크니컬 라이터가 오픈소스 기술을 익힐 수 있도록 도와주세요. 샘은 git을 사용해 본 적이 없었지만 몇 가지 튜토리얼을 진행한 후 빠르게 익숙해졌습니다. 처음에는 커뮤니티로부터 얼마나 많은 피드백을 받을 수 있고 이를 어떻게 통합할지 걱정했지만, 커뮤니티의 '대략적인 합의' 모델 ('모든 문제가 해결되었지만 반드시 수용되지는 않을 때 합의가 이루어짐') 덕분에 샘은 자신의 기술적 글쓰기 전문성을 활용해 비평에 자신 있게 대응할 수 있었습니다.
부록
연결하고 싶은 다른 자료가 있는 경우 (예를 들어 공유하려는 테크니컬 라이터와 협력하기 위한 계약을 체결한 경우, 문서 프로젝트를 위한 템플릿이나 기타 공개 문서 리소스를 나열하고 링크를 걸 수 있습니다.) 또한 부록은 사용한 문서 도구 또는 리소스의 링크를 나열하거나 위 섹션에 적합하지 않을 수 있는 감사 인사를 덧붙이는 곳이기도 합니다.
감사의 말
저희 팀은 다음과 같은 분께 감사드립니다.
- @Dillicious는 파트너와 로우파이 힙합 라디오에게도 감사를 표합니다.
- @KimChiCook은 피클링 방법을 가르쳐 주신 할머니에게 감사의 마음을 전합니다.
- @Piccalily는 Chicago Manual of Style Online에 감사드립니다.
- @GherKen은 피클을 다 먹어준 세 아이에게 감사를 전하고 싶습니다.
- @VinegarViv는 그녀의 직책을 받아들인 나머지 팀원들에게도 감사의 마음을 전하고 싶습니다.
- @BBChips는 피클 없는 최고의 음식인 Tunnock의 캐러멜 웨이퍼에 감사를 표합니다.
- @GloriousPicklePat는 이 프로젝트를 맡아준 PickleDocs SIG에 감사의 마음을 전합니다.
- 샘 스크리브는 GloriousPickle 커뮤니티 전체, 특히 2021년 여름 병이 부족할 때 통조림 병을 보내준 Pickler에게 감사를 표하고 맛있는 피클이 많이 나오기 시작했습니다.