현재 단계:
2021년 Season of Docs 프로그램은 2021년 12월 14일에 종료되었습니다. 타임라인을 참고하세요.
이 예시를 사용하여 자체 케이스 스터디 보고서를 작성하세요.
PicklePlus: GloriousPickle 기여 도구 문서화
조직 또는 프로젝트: Glorious Pickle 여기에 조직 또는 프로젝트의 기본 사이트 링크
조직 설명: GloriousPickle (현재 버전 1.2.3, 2009년 첫 출시)은 MIT 라이선스를 받은 라이브러리로, 가능한 모든 피클용 채소에 대해 소금, 설탕, 식초, 향신료의 완벽한 비율을 쉽게 계산할 수 있습니다. 계산할 수 있는 양은 하나의 어린 오이부터 컨테이너로 가득 찬 무까지 다양합니다.
저자: 선택사항: 케이스 스터디의 저자를 나열합니다. 요청하는 경우 사용자 이름을 사용합니다.
문제 서술/제안 개요
새 문서 또는 개선된 문서로 해결하려는 문제는 무엇인가요? 가능한 경우 프로젝트 사이트의 제안서 페이지 링크를 제공합니다.
GloriousPickle 도구의 재료 데이터베이스에 재료를 추가하는 작업은 시간이 많이 걸리고 복잡하며 도구에 문서가 잘 갖춰져 있지 않습니다. 많은 참여자가 git을 사용하거나 풀 리퀘스트를 제출한 경험이 없습니다. 즉, GloriousPickle의 재료 데이터에 심각한 공백이 있으며 이로 인해 도구의 유용성이 떨어집니다. 새로운 재료 추가에 관한 문서를 개선하여 신규 참여자와 더 많은 피클을 만들기를 바랍니다.
프로젝트 설명
제안서 작성
Docs 시즌 제안은 어떻게 생각해 내셨나요? 조직에서 아이디어를 결정하는 데 어떤 절차를 사용했나요? 의견을 요청하고 반영하는 방법은 무엇인가요?
GloriousPickle PickleDocs SIG는 Google의 오픈소스 프로그램 사무국의 트윗을 통해 Docs 시즌 프로그램에 관해 알게 되었습니다. SIG는 격주 회의에서 이 프로그램을 논의하고 제안서를 작성하기로 합의했습니다. SIG의 두 회원 (@KimChiCook 및 @Dillicious)이 다음 회의에서 검토할 초안 제안서를 작성하기로 자원했습니다.
PickleDocs SIG에서 제안서 초안에 동의한 후 전체 프로젝트에 의견을 요청하는 이메일을 보냈습니다. 재료 추가 API의 유지관리자인 @GloriousPicklePat을 비롯한 14명의 커뮤니티 회원이 의견을 제공했습니다. @GloriousPicklePat은 프로그램 기간 동안 리소스로 자원봉사를 하겠다고 제안했습니다.
제안서를 검토하고 받은 의견을 반영한 후 GloriousPickle 프로젝트 운영위원회에 투표를 위해 제출했습니다. GPPSC의 5명 모든 구성원이 제안서 및 신청서 제출에 찬성 투표했으며 @VinegarViv는 프로그램에 참여하고 지급을 감독하는 데 필요한 Open Collective 계정을 만드는 데 도움을 주기로 동의했습니다.
예산
예산에 관한 짧은 섹션을 포함합니다. 작업을 어떻게 추정했나요? 예상치 못한 지출이 있었나요? 결국 보조금보다 적은 금액을 지출했나요? Docs Season 외에도 사용할 수 있는 다른 자금이 있나요?
GloriousPickle PickleDocs SIG의 두 회원은 기술 문서 작성자로 일한 경험이 있습니다 (한 명은 유럽, 한 명은 아르헨티나). 이전에 작성한 제안서 초안을 비교하여 작업을 추정하고 유사한 프로젝트 예산을 찾는 데 도움을 주었습니다. 또한 2019년 PicklePals 컨벤션에서 제한 없는 스폰서십으로 받은 1,000달러가 남아 있었으며 이 금액은 프로젝트에 할당되었습니다.
산불의 영향을 받는 지역으로 이사하여 집에서 인터넷을 이용할 수 없게 된 기술 작가를 위해 Wi-Fi 핫스팟을 임대하는 데 의외의 비용이 발생했습니다. 또한 계획보다 적은 수의 티셔츠를 발송하여 균형을 맞췄습니다.
또한 기술 작가가 작성한 문서의 교정 및 교열을 도와준 GloriousPickle 참여자 @Piccalily (이전에는 피클이 아닌 분야에서 전문 교정 편집자로 활동함)에게 보상을 제공하기로 결정했습니다.
참여자
이 프로젝트에 참여한 사람은 누구인가요?(참여자의 요청이 있는 경우 사용자 이름 사용) 기술 문서 작성자를 어떻게 찾고 고용했나요? 다른 자원봉사자 또는 유급 참여자는 어떻게 모집했나요? 어떤 역할을 맡았나요? 누가 중단했나요? 채용, 커뮤니케이션, 프로젝트 관리에 대해 무엇을 배웠나요?
이 프로젝트에 참여한 핵심 팀은 다음과 같습니다.
- @Dillicious, @KimChiCook (PickleDocs SIG)
- @Piccalily (교정자)
- @GherKen, @VinegarViv (관리자 지원, GPPSC)
- @BBChips, @GloriousPicklePat (주제별 전문가)
- 샘 스크라이브 (기술 문서 작성자)
Season of Docs GitHub 저장소 목록을 통해 샘 스크라이브를 찾았습니다. 샘은 요리 잡지에서 근무한 경험이 있고 웹사이트 문서를 작성한 경험도 있어 프로젝트에 적합하다고 생각했습니다. 샘은 PickleDocs SIG의 격주 전화 회의에 참석하여 프로젝트에 관해 논의하고 여러 가지 매우 유용한 제안을 해주었으며, 제안서에 반영되었습니다. 또한 SIG 회원들의 네트워크를 통해 알고 있는 다른 두 명의 기술 작가에게도 연락을 취했으나 프로그램 기간 동안 두 사람 모두 지원해 주지 않았습니다.
샘의 시간대는 PickleDocs SIG의 대부분의 회원과 몇 시간 정도만 겹쳤기 때문에 샘의 시간대에 거주하며 재료 추가 절차에 익숙한 Pickler를 찾기 위해 토론 포럼에 공지사항을 보냈습니다. @BBChips는 샘의 질문에 답변하고 필요에 따라 다른 전문가를 찾는 것을 도와주겠다고 자원했습니다. @GloriousPicklePat은 또한 샘이 도구의 기본 아키텍처와 API의 가능한 오류 메시지를 이해할 수 있도록 도와주겠다고 자원하고 GitHub 및 git 도움말을 제공했습니다.
안타깝게도 프로그램 중간에 @VinegarViv님이 개인적인 이유로 프로젝트에서 물러나야 했습니다. GPPSC 회원인 @GherKen이 나서서 행정 및 결제 관련 질문을 처리했습니다.
몇 가지 질문을 놓친 후 (GloriousPickle은 무료 Slack 인스턴스를 사용하며, 때때로 대화가 너무 빠르게 진행되어 롤링 보관처리 한도 때문에 대화가 누락됨) 진행 중인 질문 목록을 공유 문서 (공유 Google 문서 사용)에 보관해야 한다는 사실을 알게 되었습니다. PickleDocs SIG 회원들은 회의 전에 이를 확인하고 회의가 끝나기 전에 답변을 받았습니다. 샘은 긴급한 질문을 @BBChips에 직접 핑할 수 있었습니다.
샘과 함께 작업하게 되어 매우 기뻤습니다. 샘은 GloriousPickle 문서를 업데이트하는 것 외에도 열렬한 피클 애호가가 되었습니다.
타임라인
프로젝트 일정에 대한 간단한 개요를 제공합니다 (프로젝트가 진행 중인 경우 예상 종료일 또는 중간 마일스톤을 표시).
Season of Docs 프로그램에서 참여 조직을 발표할 때까지 PickleDocs SIG 회원들은 샘에게 유용할 것으로 생각되는 이전 작업을 검색했습니다. 한 달 동안 문서 업데이트 작업이 중단된 이전 작업의 메모를 발견했으며 Google OpenDocs 저장소의 문서 성숙도 감사 자료 중 일부도 검토했습니다.
2021년 Season of Docs에 선정되었다는 좋은 소식을 듣자 샘과 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일 |
| 8월 1~20일 PickleDocs SIG 대부분이 휴가를 보냈습니다. | -- |
| 커뮤니티에서 새 문서 테스트 시작 (GloriousPickle 사이트에 초안으로 게시된 문서) | 8월 21일 |
| 테스트 의견이 반영됨 | 9월 10일 |
| 새 문서의 교정 및 교정 | 9월 17일 |
| 문서의 초안 상태가 삭제되고 문서가 공식적으로 출시됨 | 9월 28일 |
| 문서 업데이트 절차가 생성됨 | 11월 1일 |
| 이 사례 연구는 | 11월 8일 |
| 우수사례 제출됨 | 11월 16일 |
제안서 예산에서는 기술 작가가 프로젝트에 매주 10~15시간 정도를 할애할 것으로 예상했습니다. 샘은 사용 시간을 기록했으며 주당 평균 11.5시간을 사용했습니다.
결과
무엇이 생성, 업데이트 또는 변경되었나요? 가능한 경우 게시된 문서 링크를 포함합니다. 제안서에 생성되지 않은 결과물은 없었나요? 해당 항목도 나열하세요.
세 가지 주요 사용 사례가 전체 사용자 안내 가이드와 함께 문서화되었습니다.
GloriousPickle에 새 재료를 추가하는 방법
GloriousPickle에 변형 재료를 추가하는 방법
GloriousPickle에서 재료를 업데이트하거나 수정하는 방법
이 가이드에는 참여를 더 쉽게 할 수 있는 새로운 풀 리퀘스트 템플릿도 포함되어 있습니다.
또한 프로젝트 기간 동안 샘은 배운 용어에 관한 작은 Pickle 용어집을 만들었고, 이 용어집은 GloriousPickle 프로젝트 사이트에도 게시되었습니다.
이러한 사용자 안내 가이드를 업데이트하는 방법에 관한 안내가 프로젝트 위키에 추가되었습니다.
GitHub를 처음 사용하는 참여자가 Google의 프로세스와 도구를 사용하는 데 도움이 되는 요약본을 만드는 것을 포함했지만 사용 가능한 리소스를 살펴본 결과 다른 프로젝트의 요약본을 포크하는 것으로 대체할 수 있었습니다.
측정항목
프로젝트의 성공을 측정하기 위해 어떤 측정항목을 선택했나요? 해당 측정항목을 수집할 수 있었나요? 측정항목이 프로젝트에서 원하는 결과와 잘 연관되었나요? 제안 이후 측정항목이 변경되었나요?
제안서에서는 다음 두 가지 측정항목을 제안했습니다.
- 구성요소 관련 풀 요청 수
- 신규 참여자의 풀 요청 수
9월 (초안 문서 게시 후 첫 번째 정규 월)에는 성분 관련 풀 리퀘스트가 5% 증가 (8월 20개에서 9월 21개)했으며, 총 4개의 풀 리퀘스트를 제출한 신규 참여자가 3명 있었습니다 (8월에는 2개의 풀 리퀘스트를 제출한 신규 참여자가 2명). YouTube는 이러한 측정항목을 매월 추적할 계획입니다.
또한 1월 1일부터 문서가 게시된 후 분기별로 전체적으로 3회 이상 참여한 참여자 수를 추적할 예정입니다.
새로운 문서가 신규 참여자가 GloriousPickle 재료 데이터베이스에 항목을 추가하는 데 도움이 되었다는 의견이 있었습니다. 한 신규 참여자는 PR의 댓글에서 이전에 시도했지만 절차를 이해하지 못해 업데이트를 완료하지 못했다고 언급했습니다.
분석
잘 된 점은 무엇인가요? 예상치 못한 점은 무엇인가요? 어떤 장애물이나 어려움이 있었나요? 프로젝트가 성공적이라고 생각하시나요? 그 이유는 무엇인가요? (아직 판단하기 이르다면 언제 프로젝트의 성공 여부를 판단할 수 있을지 설명하세요.)
YouTube는 Season of Docs 프로젝트의 결과에 매우 만족하며 성공적이라고 생각합니다. 새로운 문서는 명확하고 유용하며, 이미 구성요소 관련 풀 리퀘스트 수와 신규 참여자의 풀 리퀘스트 수가 다소 증가했습니다.
또한 원래 제안에 대한 의견을 제공하고 초안 형태로 새 문서를 테스트하는 등 거의 모든 GloriousPickle 커뮤니티가 참여해 주셔서 기쁩니다.
예상치 못한 몇 가지 문제가 있었지만, 샘님이 거주하는 주에서 발생한 산불로 인해 인터넷 서비스 중단 외의 피해가 발생하지 않은 점에 감사드립니다. 또한 프로젝트에서 @VinegarViv님이 빠져 나가게 되어 죄송합니다. @VinegarViv님과 가족에게 좋은 일이 있기를 바라며 곧 다시 만나뵐 수 있기를 기대합니다.
샘이 문서 작업을 시작하기 전까지는 피클링 배경 지식이 없는 사용자가 프로젝트에 참여할 때 얼마나 많은 피클 관련 용어와 약어를 낯설게 느낄지 몰랐습니다. 하지만 샘은 낯선 용어를 모두 목록으로 작성하고 자체 조사를 통해 정의하거나 커뮤니티 회원에게 설명과 참고 자료를 요청했습니다. 이 피클 용어집은 향후 더 많은 사람들이 피클링 커뮤니티에 참여하도록 하는 데 큰 도움이 될 것입니다.
요약
2~4단락으로 프로젝트 경험을 요약하세요. 배운 내용과 향후 다르게 할 점을 강조하세요. 문서와 관련하여 유사한 문제를 해결하려는 다른 프로젝트에 어떤 조언을 하고 싶으신가요?
한마디로, 정말 멋진 경험이었습니다. 문서 결과물을 달성했으며 측정항목이 목표에 부합하는 것으로 보입니다.
이 프로젝트의 성공은 기술 작가인 샘 스크라이브와 함께 작업할 수 있었던 행운에 크게 기인합니다. [이 내용은 제가 작성하지 않았습니다. 샘] 샘은 피클링에 대한 배경 지식이 없고 GitHub에 대한 경험도 없었지만, 경험 많은 기술 문서 작성자로서 새로운 주제 영역을 탐색하고 질문하고 조사하는 데 능숙했습니다. 샘은 프로젝트 도구 (칸반 보드를 사용하여 업무를 추적함)뿐만 아니라 피클 농담도 금방 익혔습니다. 샘이 피클 버그를 포착하고 YouTube 커뮤니티에서 '병입'할 수 있게 되어 매우 기쁩니다.
다른 프로젝트는 다음을 수행하는 것이 좋습니다.
- 제안서를 작고 관리하기 쉽게 유지하세요. (원래는 제안서에 산업용 일괄 피클 기계에서 추정기를 사용하는 방법에 관한 문서를 포함하려고 했지만, 피클 기계의 오픈소스화에 깊이 관여하는 커뮤니티 회원 중 한 명이 프로그램 기간 동안 박사학위 논문을 작성할 예정이어서 제외했습니다.) 결국 샘이 바쁘게 지낼 만큼 충분한 작업이 있었습니다.
- 기술 작가를 찾을 때는 내 네트워크를 활용하세요. 커뮤니티의 모든 사용자에게 추천을 요청하세요. Docs Season GitHub를 통해 샘을 찾았지만 신청 기간 동안 여러 사람과 대화를 나눈 덕분에 샘과 함께 작업할 수 있다는 확신이 들었습니다.
- 기술 문서 작성자를 커뮤니티에 맞이합니다. 샘은 GloriousPicklers의 열정적인 태도 덕분에 질문하기가 쉬웠다고 말했습니다.
- 기술 문서 작성자가 오픈소스 기술을 습득하도록 지원하세요. 샘은 이전에 git을 사용해 본 적이 없었지만 몇 가지 튜토리얼을 진행한 후 빠르게 적응했습니다. 처음에는 커뮤니티에서 얼마나 많은 의견을 받을지, 어떻게 의견을 반영할지 걱정했지만 Google 커뮤니티의 '대략적인 합의' 모델 ('모든 문제가 해결되면 합의가 이루어지지만 반드시 수용되는 것은 아닙니다')을 통해 샘은 기술 문서 작성 전문성을 활용하여 비판을 자신 있게 해결할 수 있었습니다.
부록
링크를 추가할 다른 자료가 있는 경우 (예: 공유하려는 기술 작가와의 작업 계약서, 문서 프로젝트용 템플릿, 기타 공개 문서 리소스) 여기에 나열하고 링크를 추가할 수 있습니다. 부록은 사용한 문서 도구 또는 리소스의 링크를 나열하거나 위 섹션에 포함되지 않는 감사의 인사나 확인사항을 추가하는 데도 적합합니다.
감사의 말
YouTube는 다음과 같은 인물과 사항에 감사의 인사를 전하고자 합니다.
- @Dillicious는 파트너와 로우파이 힙합 뮤직 스테이션에 감사의 인사를 전합니다.
- @KimChiCook은 할머니께서 피클 만드는 법을 가르쳐 주셔서 감사하다고 말하고 싶습니다.
- @Piccalily님은 시카고 스타일 매뉴얼 온라인에 감사의 인사를 전합니다.
- @GherKen은 자신이 만든 피클을 모두 먹어 준 세 자녀에게 감사의 인사를 전합니다.
- @VinegarViv는 사임에 협조해 주신 나머지 팀원들에게 감사의 인사를 전합니다.
- @BBChips는 피클이 아닌 최고의 음식인 Tunnock's Caramel Wafers에 감사를 표합니다.
- @GloriousPicklePat은 이 프로젝트를 맡아 준 PickleDocs SIG에 감사의 인사를 전합니다.
- 샘 스크라이브는 GloriousPickle 커뮤니티 전체에 감사의 인사를 전합니다. 특히 2021년 여름에 병이 부족할 때 맛있는 피클을 만들 수 있도록 보존용 병을 보내주신 피클러 여러분께 감사드립니다.