현재 단계:
2021년 Docs 시즌 프로그램이 2021년 12월 14일에 종료되었습니다. 타임라인을 참고하세요.
문서 시즌 정보
Season of Docs는 Google Open Source Programs Office에서 관리하는 지속 가능성 프로그램입니다. Docs 시즌의 목표는 다음과 같습니다.
- 문서로 프로젝트 문제를 해결할 수 있도록 오픈소스 프로젝트 지원 제공
- 테크니컬 라이터에게 오픈소스에서 경험을 얻을 수 있는 기회 제공
- 오픈소스, 문서, 기술 문서 작성에 대한 인식 제고
- 오픈소스 문서에서 효과적인 측정항목에 대한 정보 수집 및 공유
Season of Docs에 대한 자세한 내용은 프로그램 웹사이트에서 확인할 수 있습니다.
2021년 프로그램 개요
2021년 프로그램 변경사항
2019년과 2020년에는 조직 및 테크니컬 라이터가 각각 Docs 시즌 프로그램에 개별적으로 신청했으며, 테크니컬 라이터와 테크니컬 라이터는 Docs의 시즌 프로그램 관리자가 해당 조직과 매칭했습니다. 조직에서는 테크니컬 라이터와 협업할 수 있도록 멘토를 제공했으며, 테크니컬 라이터들은 위치에 따라 작업에 대한 보조금을 받았습니다. 이 프로그램은 테크니컬 라이터, 멘토, 조직 관리자가 프로그램 참여에 만족했는지를 측정했지만 문서 결과는 측정하지는 않았습니다.
2021년, Docs의 Season of Docs팀은 프로그램에 대대적인 변화를 주어 문서 결과를 측정하고 조직과 테크니컬 라이터의 유연성을 높이는 방향으로 초점을 옮겼습니다.
- 예산, 제안된 측정항목을 포함한 프로젝트 제안서를 적용한 조직
- 테크니컬 라이터가 조직과의 매칭을 위해 더 이상 Google을 통해 신청하지 않고 승인된 조직에 직접 신청함
- 승인된 조직은 Open Collective를 통해 보조금을 받아 테크니컬 라이터에게 보수를 지급했습니다.
- 테크니컬 라이터에 대한 보상은 조직에서 책정함
- 조직에서 최종 평가와 우수사례를 제출하고 후속 설문조사에 답했습니다.
2021년 일반 결과
조직
- 2021년 프로그램의 변화로 인해 신청하는 조직이 줄었지만(2020년 대비 2021년 신청한 조직이 30% 감소) 2021년 조직 관리자가 프로그램에 대해 2020년 관리자(93% 대 91%)보다 약간 더 만족했습니다(93% 대 91%).
문제, doctype, 측정항목
- 대부분의 프로젝트는 (문제/질문을 줄임) 유지관리자의 부담을 줄이거나 (프로젝트 사용자 또는 참여자의) 프로젝트 참여를 늘리는 문서 작성에 중점을 둡니다.
- 승인된 조직의 50% 가 튜토리얼 또는 방법 안내 콘텐츠를 제작했습니다.
- 승인된 조직의 50% 이상이 현재 문서가 부족하거나 정리되지 않았거나 오래되었다고 생각했습니다.
- 프로젝트에서는 일반적으로 상호작용을 통해 문서 효과, 특히 발생하는 문제가 줄어들고 문서 방문자 및 프로젝트 참여를 통해 문서화 효과를 측정하고자 했습니다.
- 2022년 11월 현재, 프로젝트 30개 중 25개가 응답:
- 18개 프로젝트는 원래 측정항목을 충족했다고 답했습니다.
- 프로젝트 5개가 수정된 측정항목을 충족함
- 프로젝트 2개에서 아직은
프로그램 참여
- 테크니컬 라이터를 모집, 고용하고 지불하는 것은 조직 관리자가 이 프로그램에서 가장 어려운 부분이었습니다.
- 2022년 11월 현재 30개 조직 중 24개 조직이 응답:
- 18개 조직이 여전히 Docs 시즌 테크니컬 라이터 (지속적 기여자 또는 질문 답변 리소스)와 협력하고 있었습니다.
- 조직 4곳에서 유급 직무를 맡고 있는 Docs 시즌 테크니컬 라이터와 협업하고 있었습니다.
- 18개 조직이 여전히 Docs 시즌 테크니컬 라이터 (지속적 기여자 또는 질문 답변 리소스)와 협력하고 있었습니다.
2021년 하이라이트
- 여러 프로젝트에서 테크니컬 라이터가 Docs의 Season of Docs 프로그램이 끝난 후에도 프로젝트를 계속 작업하겠다고 밝혔습니다.
- Metanorma는 자격을 갖춘 많은 테크니컬 라이터들이 지원하게 되어 프로그램 기간 동안 Docs 지원 작가와 함께 작업할 추가 작가를 고용하기 위해 일치하는 자금을 찾았습니다.
- Moja Global은 커뮤니티에서 문서화에 매우 관심이 많다는 것을 알게 되었고 더 많은 기고자가 프로젝트 문서에 참여할 수 있도록 새로운 문서 작업 그룹을 구성했습니다.
2021년 요약 데이터
2021년에는 82개의 조직이 프로그램에 신청했으며 30개의 오픈소스 조직이 프로그램 참가 신청을 승인했습니다. 선택 기준은 애플리케이션 만들기 가이드를 참조하세요. 참여 조직의 전체 목록은 Season of Docs 웹사이트에서 확인할 수 있습니다. 승인된 30개 조직 모두 2021년 프로그램 참여를 완료하기 위해 최종 우수사례 보고서를 제출했습니다.
조직 정보
Docs 시즌 2021에 참여한 조직은 다양한 오픈소스 프로젝트를 대표했습니다. 2021년 사용자 집단에는 다음이 포함됩니다.
- 대규모 언어 프로젝트(예: Julia, Perl, R)
- 교육, 기후, 핀테크, 의료, 도서관 서비스, 머신러닝, 질량 분석법, 공공 계약, 로봇공학 프로젝트
- 카오스 엔지니어링 도구, fuzzer, 챗봇 SDK, 소프트웨어 구성 분석 파이프라인, 성능 모니터링 도구, 시각적 프로그래밍 도구를 포함한 개발자 중심 프로젝트
- Redocly 및 Metanorma와 같은 문서 도구를 위한 문서 프로젝트
Python 생태계 프로젝트는 가장 큰 하위 카테고리였습니다. 2021년 사용자 집단에는 ArviZ, NumPy, MicroPython, PyMC3, PyTorch-Ignite, SymPy가 포함되었습니다.
Google은 창립일, 참여자의 지리적 분포, 참여자 수, 사용자층 규모 등 프로젝트에 대한 어떠한 메타데이터도 수집하지 않았습니다.
우리는 프로젝트에 어떤 오픈소스 라이선스를 사용했는지 표시해 달라고 요청했습니다.
2021년 조직이 정리한 문서 관련 문제는 오픈소스 프로젝트와 일반적인 기술 문서 모두에서 매우 흔한 문제입니다.
2021년 이 프로그램을 통해 조직이 해결하고자 했던 주요 문제는 다음과 같습니다.
조직은 여러 문서 문제를 보고할 수 있습니다. 자세한 내용은 각 조직의 전체 우수사례 링크를 확인할 수 있는 Docs 2021 시즌 결과 페이지를 참고하세요.
생성된 문서의 유형
튜토리얼은 2021년 우수사례에서 가장 많이 언급된 문서 유형입니다.
우수사례에서 언급된 다른 문서 유형으로는 코드형 문서 파이프라인, 다이어그램, 용어집, 스타일 가이드, FAQ, 국제화, Codelab, 콘텐츠 모델, 모듈, 개념 문서, 오류 메시지, 사용자 연구, 리드미, 기술 자료가 있습니다.
이러한 카테고리 중 일부는 모호하며 단일 문서 프로젝트에 여러 문서 유형 또는 기능이 포함될 수 있습니다.
특히 문서 유형 계획을 위한 가이드로 Diátaxis 프레임워크를 사용하여 참조된 여러 프로젝트입니다.
자세한 내용은 각 조직의 전체 우수사례 링크를 확인할 수 있는 Docs 2021 시즌 결과 페이지를 참고하세요.
예산
2021년 평균 예산 요청은 $10,200였고 중앙값은 $10,000였습니다. 오직 3개의 조직만이 최대 지원금 ($15,000)을 요청하여 받았으며 다른 3곳은 가능한 가장 낮은 지원금 ($5,000)을 요청했습니다.
측정항목
우수사례에서 문서 프로젝트의 성공 여부를 측정하기 위해 사용한 측정항목을 프로젝트.
제안된 상위 측정항목은 다음과 같습니다.
제안된 기타 측정항목으로는 GitHub 별표, 페이지에 머문 시간, 메일링 리스트 전환, 정성적 사용자 테스트, 포럼 참여자 수, 파트너/자원봉사자/통합 수 등이 있습니다.
기술 문서 작성 프로젝트를 마치고 우수사례를 제출할 때까지 걸리는 시간이 짧았기 때문에 2021년 사용자 집단 대부분은 초기 측정항목이 충족되었는지 여부를 판단하기에 충분한 데이터를 수집하지 못했습니다.
자세한 내용은 각 조직의 전체 우수사례 링크를 확인할 수 있는 Docs 2021 시즌 결과 페이지를 참고하세요.
테크니컬 라이터와 협력
2021년 Docs 시즌 프로그램의 가장 큰 변화는 프로젝트를 테크니컬 라이터와 협업하는 방식이었습니다. 초기 시즌에는 테크니컬 라이터들이 Google에 직접 지원하여 프로그램 관리자와 프로젝트를 연결했고 Google로부터 직접 고정 지원금을 받았습니다.
2021년에는 테크니컬 라이터들이 프로젝트에 직접 지원했고 프로젝트에서는 Docs Season of Docs의 Open Collective 펀드를 통해 지급되는 테크니컬 라이터 보상용 예산을 설정했습니다.
2021년 프로그램에 참여한 대부분의 프로젝트는 테크니컬 라이터를 모집하거나 고용한 경험이 거의 없거나 전혀 없었으며, 많은 프로젝트에서 이 과정의 이 부분을 추가 지원이 필요하다고 지적했습니다. 이 의견에 따라 Docs Season of Docs팀은 프로그램 가이드에 테크니컬 라이터 계약 작성에 대한 문서를 추가했습니다.
채용 권장사항
Season of Docs에 참여하는 데 관심이 있는 다른 프로젝트를 위해 프로젝트를 추천해 달라는 요청을 받았습니다. 상위 채용 권장사항은 다음과 같습니다.
- 프로그램에 승인되기 전이라도 테크니컬 라이터 채용 자료를 최대한 빨리 공유하세요. 커뮤니티에 가능한 후보자를 추천해 달라고 요청합니다.
- 프로젝트 채널 외부에 널리 공유합니다. 포용적인 표현을 사용하고 소외 계층의 지원자들이 지원하도록 직접적으로 독려합니다.
- 문서 작성 프로세스에 필수적인 도구를 이해하고 해당 도구를 사용해 본 경험이 있는 기술 작성자를 모집하세요.
- 테크니컬 라이터에게 결과물 및 마일스톤, 커뮤니케이션 채널 및 체크인, 결제 프로세스 및 시기에 대한 명확한 기대치를 설정합니다.
- Docs의 Season of Docs 테크니컬 라이터를 통해 멘토링과 코칭을 제공하여 커뮤니티 멤버에 투자하고 테크니컬 라이터로 성장하도록 도와주세요.
- 테크니컬 라이터 온보딩과 질문에 답하고 프로그램 중에 지원을 제공하는 데 예상보다 더 많은 시간을 할애합니다. 특히 프로젝트 영역에서 이전에 경험이 없는 테크니컬 라이터가 있다면 더욱 그렇습니다.
- 향후 프로젝트에 사용할 채용, 채용, 온보딩 과정을 문서화합니다.
(참고: 테크니컬 라이터 후보를 채용한 우수사례에 나와 있는 모든 프로젝트가 있는 것은 아닙니다.)
테크니컬 라이터와 작업할 때 일반적으로 발생하는 문제
여러 프로젝트의 테크니컬 라이터들이 코로나19 또는 기타 질병으로 인해 또는 팬데믹과 관련된 가족의 책임 때문에 중퇴해야 했습니다. 일부 프로젝트에서 시간대 불일치 또는 인터넷 연결 문제와 관련된 통신 문제가 보고되었습니다.
프로젝트에서 커뮤니티 온보딩 또는 프로젝트의 문서 도구 모음을 설정하는 데 수반되는 어려움을 과소평가한 것으로 나타났습니다.
일부 프로젝트에서는 Open Collective의 은행 문제 또는 작가의 거주 국가에 지불 제한이 있었기 때문에 기술 작가에게 지불이 지연되었습니다.
Open Collective 수수료에 관한 프로그램 문서가 명확하지 않았습니다. Google은 프로젝트로의 최초 송금에 대한 Open Collective 거래 수수료를 지불했지만 다른 결제 채널에서 부과하는 거래 수수료 (예: 환전 수수료)는 지급하지 않았습니다. 향후 프로그램을 위해 문서에서 이 부분을 명확히 하기 위해 노력할 것입니다.
후속 설문조사
Docs 프로그램의 일환으로 여러 프로젝트에 후속 설문조사에 참여해 달라는 요청을 받았습니다. 2022년 5월, 8월, 11월에 3건의 설문조사가 전송되었습니다.
후속 설문조사에서는 프로젝트에 제안서와 우수사례 링크가 여전히 활성 상태인지 확인하도록 요청했습니다. 설문조사에는 또한 프로젝트의 성공 (우수사례에서 설정한 측정항목에 따라 결정됨)과 프로젝트 테크니컬 라이터의 지속적인 참여 및 보상에 관한 질문도 포함되었습니다.
- 아직 Docs 시즌 테크니컬 라이터와 함께 작업 중이신가요?
- 기술 작성자가 아직 프로젝트를 작업 중인 경우 어떤 방식으로든 보상을 받고 있나요?
- 현재 문서 프로젝트가 성공적이라고 생각하시나요?
향후 질문
언제나 그렇듯이, 오픈소스의 문서에 대해 더 많이 배울수록 더 많은 것을 배우고자 합니다. 향후 시즌에는 다음과 같은 내용을 학습할 수 있기를 바랍니다.
- 프로젝트 도메인이 문서 유형 선택 또는 측정항목 선택과 상관관계가 있는지 여부
- 프로젝트 완료와 테크니컬 라이터 유지에 가장 효과적인 테크니컬 라이터 채용 및 온보딩 관행은 무엇인가요?
- 문서 효과 측정을 위한 합리적인 일정
조사해 보고 싶은 질문이 많지만, Docs Season of Docs에 참여하는 오픈소스 프로젝트 관리자 및 유지보수 담당자들의 시간을 존중하고자 합니다. 프로그램의 최우선순위는 문서 문제를 해결하도록 프로젝트를 지원하는 것입니다.