현재 단계:
문서 개발 타임라인을 참고하세요.
Season of Docs는 Google Open Source Programs Office에서 관리하는 지속 가능성 프로그램입니다. Season of Docs의 목표는 다음과 같습니다.
- 문서로 프로젝트 문제를 해결할 수 있도록 오픈소스 프로젝트 지원 제공
- 테크니컬 라이터에게 오픈소스 경험을 얻을 수 있는 기회 제공
- 오픈소스, 문서, 기술 문서화에 대한 인식 제고
- 오픈소스 문서에서 효과적인 측정항목에 대한 정보 수집 및 공유
Season of Docs에 관한 자세한 내용은 프로그램 웹사이트에서 확인할 수 있습니다.
2022년 프로그램 개요
문서 시즌의 작동 방식
Season of Docs는 조직들이 프로젝트 제안서를 제출하여 신청합니다. 프로젝트 제안서에는 다음이 포함됩니다.
- 조직에 관한 정보
- 프로젝트가 직면한 문제에 대한 설명
- 프로젝트가 문제를 해결하기 위해 문서를 사용하는 방법
- 프로젝트가 문서의 효과를 측정하는 방법 (측정항목)
- 작업 일정
- 프로젝트 예산
- 유사한 프로그램에서의 조직 경험과 같은 추가 정보나 Season of Docs 관리자가 프로젝트와 문제를 이해하는 데 도움이 되는 기타 정보
프로그램 가입이 수락되면 조직은 자체 테크니컬 라이터를 직접 모집하고 채용합니다. Season of Docs는 Open Collective를 사용하여 조직에 자금을 지원하고 조직은 Open Collective를 통해 테크니컬 라이터에게 비용을 지불합니다. 프로젝트 예산과 결제는 투명하게 공개됩니다. 예산은 Season of Docs 사이트에서 제공되는 조직 프로젝트 제안서에 포함되며 Docs Open Collective 계정에서 확인할 수 있습니다.
우수사례 보고서를 제출하면 프로그램을 이수한 것으로 간주됩니다. 또한 조직은 프로그램 기간 동안 월별 평가를 완료하고 프로그램 완료 후 1년 동안 3번의 분기별 후속 설문조사를 완료해야 합니다.
2022년 하이라이트
“새 문서가 공개된 후 Casbin과 Casdoor의 일일 방문수가 거의 2배로 증가했으며 이탈률은 약 30% 감소했습니다.”—캐빈
“[테크니컬 라이터] 들이 커뮤니티에서 리더 역할을 하는 과정을 지켜보는 것도 이 프로젝트를 통해 즐거운 일입니다. 현재 두 사람 모두 실무 그룹과 커뮤니티 회의를 주도하고 있으며 프로젝트의 설계 및 유지관리에도 기여하고 있습니다.” —moja-global
“[GSoD] 덕분에 정규 환경에서 매우 어려운 2명의 재능 있는 테크니컬 라이터를 채용할 수 있었습니다. 이들은 OpenMined에 지속적으로 OS를 적극적으로 기여하고 있으며 훌륭한 업무 경험을 쌓은 유능한 테크니컬 라이터입니다.” —OpenMined
"또한 새 매뉴얼은 초보자가 전산 질량 분석을 훨씬 쉽게 수행할 수 있습니다. 이를 설명하기 위해 CZI 보조금은 역사적으로 소외된 개인에게도 금전을 제공합니다. 일부 수혜 단체는 새로운 OpenMS 매뉴얼을 사용하여 6주간의 인턴십 기간을 단축했으며 새로운 매뉴얼에 대한 긍정적인 평가를 받았습니다.” —OpenMS
2022년 요약 데이터
2022년, Season of Docs 프로그램은 67건의 지원서에서 31개의 프로젝트가 접수되었으며, 30개의 프로젝트가 프로그램을 성공적으로 수료했습니다. 승인된 31개 조직 중 17개 조직이 반복 신청했습니다.
31개 프로젝트는 58명의 테크니컬 라이터를 고용했습니다. 190명 이상의 테크니컬 라이터가 연락처 정보와 포트폴리오 링크를 Docs의 Season of Docs GitHub 저장소에 추가하여 프로그램에 참여할 의사가 있음을 밝혔습니다.
2022년 프로그램:
- 100% 의 조직이 신청 절차에서 긍정적인 경험을 했습니다.
- 100% 의 조직이 프로그램 웹사이트 문서/콘텐츠에 대해 긍정적인 경험을 가짐
- 93% 의 조직이 프로그램에 대해 긍정적인 경험을 함
- 조직의 90% 는 문서화 프로젝트가 성공적이라고 생각함
조직 정보
Season of Docs 2022에 참여한 조직은 다양한 오픈소스 프로젝트를 대표했습니다. 2022년 사용자 집단에는 다음이 포함됩니다.
- 개발 도구(예: AsyncAPI 및 SpyderIDE)
- 프로그래밍 언어 및 프레임워크(예: Julia, LFortran, R, p5.js)
- 과학 프로젝트(예: CERN-HSF, SymPy)
- 최종 사용자 애플리케이션(예: Mautic, Open Food Facts, Talawa, Ushahidi)
- 하드웨어 및 로봇 프로젝트(예: ExpressLRS 및 Open-RMF)
- 데이터 프로젝트(예: GeomScale, GeomStats, OpenMined, Weaviate)
- 클라우드 및 인프라 프로젝트(예: cert-manager, NimbleEdge, Cilium)
Google은 프로젝트와 관련된 메타데이터 (예: 창립일, 참여자의 지리적 분포, 참여자 수, 사용자층 크기 등)를 수집하지 않았습니다.
Google은 프로젝트에 어떤 오픈소스 라이선스를 사용했는지 표시해 달라고 요청했습니다.
문서 프로젝트 정보
문서 문제
2022년 프로그램에서 문서화로 해결하고자 하는 주요 문제는 다음과 같습니다.
조직은 여러 건의 문서 관련 문제를 보고할 수 있습니다. 자세한 내용은 각 조직의 원본 프로젝트 제안서와 전체 우수사례로 연결되는 2022년 Docs 시즌 결과 페이지를 참고하세요.
생성된 문서의 유형
방법 문서는 2022년 우수사례에서 가장 많이 언급된 문서 유형입니다.
우수사례에 언급된 다른 문서 유형은 다음과 같습니다.
- 빠른 시작
- 용어 설명
- FAQ
- 기술 자료
- 구성요소
- 블로그/소셜 미디어 콘텐츠
- 유지관리자 가이드
이러한 카테고리 중 일부는 모호하며 단일 문서 프로젝트에 여러 문서 유형 또는 기능이 포함될 수 있습니다.
자세한 내용은 각 조직의 원본 프로젝트 제안서와 전체 우수사례로 연결되는 2022년 Docs 시즌 결과 페이지를 참고하세요.
예산
평균 예산 요청 금액은 $11,679였으며 중간값은 $12,150였습니다. 5개 조직이 가장 높은 지원금 ($15,000)을 요청하여 받았으며 가장 낮은 지원금 ($5,000~$7,000)을 요청한 조직이 3개였습니다.
측정항목
문서 프로젝트의 성공을 측정하기 위해 사용한 측정항목을 우수사례에서 요약한 프로젝트
제안된 상위 측정항목은 다음과 같습니다.
제안된 기타 측정항목은 다음과 같습니다.
- 문서 pull 요청/참여 더보기
- 문서 페이지에 대한 보다 직접적인 피드백
- 페이지에 머문 시간
- 제기된 문제 (사용을 위한 프록시로)
- 포럼 참여자
- 파트너/자원봉사자/통합 수
- 이탈률 감소
- 지역사회 내 인지도 상승
기술 문서 작성 프로젝트를 마치고 우수사례를 제출할 때까지 걸리는 시간이 짧았기 때문에 2022년 사용자 집단 대부분은 우수사례 제출 시점에 초기 측정항목이 충족되었는지 여부를 확인하기에 충분한 데이터를 수집하지 못했습니다.
2023년 후속 설문조사에 대한 답변을 받으면 이 보고서를 업데이트하여 어떤 프로젝트가 측정항목을 달성했거나 측정항목을 수정했는지에 대한 정보를 추가할 예정입니다.
자세한 내용은 각 조직의 원본 프로젝트 제안서와 전체 우수사례로 연결되는 2022년 Docs 시즌 결과 페이지를 참고하세요.
테크니컬 라이터와 협업
Season of Docs 프로그램의 프로젝트는 테크니컬 라이터를 직접 모집, 인터뷰, 채용하고 임금을 지급해야 합니다. 테크니컬 라이터는 Season of Docs가 관리하는 GitHub 저장소 디렉터리에 자신을 추가할 수 있지만 Docs의 Season of Docs 직원은 테크니컬 라이터를 심사하거나 추천하지 않습니다.
오픈소스 프로젝트의 테크니컬 라이터 고용 권장사항
테크니컬 라이터를 모집, 채용하고 협업하기 위한 권장사항을 공유해 달라는 요청을 받았습니다. 상위 추천은 다음과 같습니다.
채용
- 단순히 이력서를 검토하는 대신 더 적은 수의 지원자를 인터뷰하고 실시간 연습 세션을 사용
- 프로젝트의 언어 또는 도구 사용 능력보다 서면 및 구두 의사소통 기술을 중시합니다.
- 테크니컬 라이터가 프로젝트 작업에 필요한 도메인 지식을 습득하는 방법에 대해 직접적으로 질문합니다.
- 프로젝트의 사명에 열정이 있고 핵심 오픈소스 가치를 공유하는 사람은 전체 프로젝트를 진행하는 동안 계속 동기 부여를 받을 가능성이 더 높습니다.
- 다양한 관점과 배경이 프로젝트에 도움이 되므로 전 세계의 지원자에게 열린 자세를 유지하세요. 하지만 작가와 멘토가 서로 충돌하는 시간대에 너무 많은 경우 원활한 의사소통을 위해 많은 노력이 필요할 수 있다는 점에 유의하세요.
구인
- 결과물, 지급 일정, 구체적인 약정 기간이 명시된 계약을 사용합니다.
- 프로젝트에 알 수 없는 내용이 많다면 문서 작성과 별도로 탐색 또는 조사의 주요 시점을 포함하세요.
조정 및 커뮤니케이션
- 프로젝트에 참여하는 모든 사람이 맥락과 다음 단계를 더 쉽게 이해할 수 있도록 회의 로그 기록 결정을 보관합니다.
- 주간 통화, 일일 이메일, 채팅 채널 상태 업데이트 등 예상되는 커뮤니케이션 내용과 빈도를 명확히 하세요.
- '무엇'이 아닌 '이유'를 포함하여 신속하게 응답하고 명확한 피드백 제공
- 테크니컬 라이터를 더 광범위한 커뮤니티와 연결하여 맥락을 제공하고 작업에 대한 친목을 도모하세요.
프로세스 및 도구
- Season of Docs 프로그램을 종료하고 전체 커뮤니티가 기여할 수 있는 문서 프로세스를 만듭니다.
- 문서 검토는 적어도 코드 검토만큼이나 집약적이므로 충분한 시간을 할애해야 합니다.
일부 권장사항이 명확성을 위해 수정 및 요약되었습니다.
2021년 프로그램에서는 Docs 2022 시즌에 참여한 대부분의 테크니컬 라이터가 함께 일하는 조직에 직접 지원했습니다.
테크니컬 라이터와 협업할 때 일반적으로 발생하는 문제
2022년 프로그램에서 테크니컬 라이터와 협력하는 데 문제가 있다고 보고된 프로젝트가 줄었습니다. 테크니컬 라이터가 프로그램을 완료할 수 없는 것이 가장 큰 문제는 질병이 있거나, 전업으로 일하거나, 약속된 시간을 감당할 수 없기 때문입니다.
한 프로젝트에서 문서 프로젝트가 Google 프로그래밍 경진대회(Summer of Code)에 참여한 작업에 의존하며 이러한 종속 항목을 관리하기가 어려웠다고 보고했습니다. 테크니컬 라이터가 문서화하는 데 필요한 하드웨어를 작가가 거주하는 국가의 국방부에 압수하여 가져올 수 없게 되면서 또 다른 프로젝트가 어려움을 겪었습니다.
후속 설문조사
2023년 5월, 8월, 11월에 2022년 참여자를 대상으로 세 가지 후속 설문조사가 발송될 예정입니다. 결과가 나오면 이 섹션을 업데이트하겠습니다.
향후 질문
늘 그렇듯 오픈소스의 문서에 대해 더 많이 알게 될수록 더 많은 것을 배우고자 합니다.
향후 시즌에는 다음과 같은 목표를 달성할 수 있기를 바랍니다.
- 더 많은 프로젝트 메타데이터를 수집하여 프로젝트 기간, 커뮤니티 규모, 언어 및 문서 요구사항 간의 상관관계를 찾습니다.
- 문서 프로젝트를 분석하여 공유 가능한 템플릿으로 일반화할 수 있는지 확인
- 오픈소스 프로젝트의 테크니컬 라이터 인터뷰에 대한 기준표 개발
조사해 보고 싶은 의문점이 많지만 Google은 Season of Docs에 참여하는 오픈소스 프로젝트 관리자 및 유지관리 담당자들의 시간을 존중하고자 합니다. 프로그램의 최우선 과제는 문서로 문제를 해결하는 프로젝트를 지원하는 것입니다.