본문 바로가기

테크니컬 라이팅/WTD 컨퍼런스

WTD 포틀랜드 2022 - 구글은 문서를 어떻게 평가할까?

반응형

제목은 낚시였습니다. 정확하게 이야기하면 평가 지표 등은 오픈소스 프로젝트 조직에서 결정하는 것이고 구글은 이를 지원하는 역할만 하는 거라서~~

 

개인적인 정리

Season of Docs 프로그램은 2019년 시작됐습니다. 그때는 테크니컬 라이터 Sarah Maddox와 오픈소스 담당자 Andrew Chen가 진행을 했었다고 합니다.
https://opensource.googleblog.com/2019/03/introducing-season-of-docs.html

 

초기에는 오픈소스 운영자에게 좋은 문서를 더할 수 있는 기회를 제공하고 테크니컬 라이터에게는 오픈소스 프로젝트에 참여할 기회를 주는 것이죠. 운영 방식 아이디어는 Summer of Code에서 가져왔는데 Summer of Code는 멘토링에 초점을 맞추고 있다면 Season of Docs는 이슈 중에서 문서화 관련 요구사항을 확인하고 리소스를 제공(연결)해 이를 해결하는데 초점을 맞추었다고 합니다.

2021년에 운영 방식을 일부 개선합니다.
프로젝트에 대한 자금을 지원하고 이번 세션 제목처럼 문서에 대한 평가(효과)를 추가한 겁니다. 이를 통해 다른 오픈소스 프로젝트 문서화 시에 모범 사례처럼 참고할 수 있도록 하려는 것이 아니었나 싶습니다.

2021년과 2020년 개요를 비교해보면 아래와 같습니다.
2020년은 부족한 오픈소스 문서화를 지원하는데 그쳤다면 2021년의 변화는 다른 오픈소스 프로젝트에서도 Season of Docs에서 공유한 자료를 기반으로 오픈소스 문서화를 진행할 수 있게 한다는 것이죠. 뭔가 물고기를 잡아주는 것이 아니라 물고기를 잡을 수 있는 방법을 알려주는 느낌이네요.

 


2020년
- 오픈소스 프로젝트 문서 개선을 위해 테크니컬 라이터와 함께 일할 수 있는 프레임워크 제공
- 오픈소스 문서화에 대한 대중적인 인식 제고

https://developers.google.com/season-of-docs/docs/2020

2021년
- 문서화 프로젝트 자금 지원
- 오픈소스 조직에서 문서 요구사항을 이해하는데 도움이 되는 가이드, 지원 제공
- 문서 영향력을 측정하기 위해 오픈소스 조직에서 데이터 수집
- 모범 사례 공유

https://developers.google.com/season-of-docs/docs/2021

대부분의 프로젝트에서 참여자를 모으는 것이 어려웠다고 합니다. 코로나 시국이라 더 어려웠을 것 같기도 하구요(이전에는 구글이 테크니컬 라이터 선발에 관여를 했는데 2021년부터는 각 오픈소스 프로젝트에서 자율적으로 진행하는 것으로 변경됐습니다). 테크니컬 라이터에게 주어지는 비용은 프로젝트마다 다르긴 한데 afl++ 같은 경우 일당 500달러로 계산해서 20일에 10,000달러를 지급했다고 합니다. 뭐 그쪽 시세도 있긴 하겠지만~ 오픈소스 프로젝트 참여를 시세대로(?) 받았다는 것이 좀 놀랍네요.

https://github.com/AFLplusplus/AFLplusplus/blob/d51ec57d91e8f4b80f8970268abdeda7e5c7c0fe/docs/docs.md

구글은 뭔가 획기적인 평가 기준을 제시할 것으로 생각했으나...

앞에서도 이야기했지만 각 기준은 오픈소스 프로젝트에서 정한 겁니다.

평가 기준이 좀 아쉽긴 한데, 아무래도 뭔가 수치로 나타내려다보디 정량적인 수치를 선택한 것이 아닌가 싶습니다.

1번 같은 경우에는 사실 이게 문서 덕분인지 아니면 프로젝트에 대한 관심이 줄어서 그런건지 애매한 측면이 있어서~
- 신규 이슈(질문), PR
- 페이지뷰
- 오픈소스 프로젝트 참여
- 새로운 문서 수

 


테크니컬 라이터가 중간에 탈락하는 경우도 많은데 주로 개인적인 사유(병이나 다른)가 많고 커뮤니케이션 문제 때문에 탈락하는 경우도 많다고 합니다. 그리고 자금 지원이 프로젝트 초기에 40%가 지급되고 나머지 60%는 프로젝트 종료 시 지급되는 것이라 일부 프로젝트에서는 다른 곳에서 자금 지원을 따로 받아서 먼저 지급을 하는 등의 어려움도 있었다고 하네요. 후불 조건도 참여자 모집에 어려움이 아니었을까 싶습니다.

 

 

참고

아무래도 Season of Docs는 영어권 프로젝트 위주라 문서 참여 역시 영작 능력이 필요합니다. 참여는 하고 싶은데 영어 능력이 아쉽다면 비슷한 형태로 국내에서도 "오픈소스 컨트리뷰톤 멘토링 행사" 중 문서화에 참여할 수 있습니다.

올해 시작은 7월 4일인데 아직 모집 기간이 올라오지 않았네요~

https://www.oss.kr/contribution_academy

 

공개SW 포털 - 공개SW 포털

공개SW 포털

www.oss.kr

영상

https://youtu.be/HCYJB23Gj2M

 

현장 스케치

https://flic.kr/p/2nnCDJf

 

Kassandra Dhillon and Erin McKean - Measuring Documentation Success in Open Source: Findings from Google's Season of Docs Progra

Explore writethedocs' photos on Flickr. writethedocs has uploaded 2645 photos to Flickr.

www.flickr.com

 

 

728x90