Wikimedia Foundation 프로젝트

이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
Wikimedia Foundation
테크니컬 라이터:
파비트라 에스와라무시
프로젝트 이름:
Wikimedia의 기술 다큐멘터리와 동영상 예술가를 위한 문서 개선
프로젝트 기간:
표준 기간 (3개월)

Project description

1. 내 정보

몇 달 전에 오픈소스 소프트웨어를 접했고 그 무한한 범위에 의해 압도된다는 느낌을 받았습니다. 수많은 프로젝트를 진행하느라 애쓰던 중, Google 프로그래밍 경진대회(Summer of Code) 및 공익사업(Summer of Code)과 같은 오픈소스 이니셔티브에 대해 알게 되었습니다. Google 문서 시즌이 흥미로워 보였고 Wikimedia Foundation의 프로젝트 아이디어에 호기심이 생겨서 탐색을 시작했습니다.

지금까지 저의 여정은 흥미진진하고 혼란스러웠습니다. “잠깐, 뭐지?”, “아, 알겠어요!” 및 “이걸 댓글을 달까요?”로 가득 차 있습니다. Wikimedia 커뮤니티는 모든 단계에서 도움을 주었습니다. 페이지 수정에서 광고 확장 만들기에 이르기까지 저는 매일 새로운 것을 배웠습니다.

애플리케이션 프로세스는 오픈소스 커뮤니티로 가는 관문 역할을 했습니다. 이 제안서는 제가 초보자로서 경험한 것에서 영감을 받았습니다.

2. 프로젝트

2.1. 윤곽선

이 프로젝트의 목표는 Wikimedia 전반의 테크니컬 라이터와 잠재적 동영상 예술가를 위한 문서를 개선하는 것입니다. 성숙한 기술 문서 가이드라인 모음은 전반적인 문서 개선에 도움이 되며 스크린캐스트 생성에 관한 참조는 소프트웨어 기능을 효과적으로 시연하는 데 도움이 됩니다. 신규 사용자와 숙련된 참여자 모두를 보다 효과적으로 지원하기 위해 이러한 영역의 기존 문서를 확장할 수 있습니다. 이러한 편리한 리소스 네트워크를 개발하기 위해 점진적 접근 방식을 채택할 것입니다.

2.2. 결과물

  • T197006 [https://phabricator.wikimedia.org/T197006] - Wikimedia의 다큐멘터리를 위한 문서 개선:

    • 문서/스타일 가이드에 도움말과 예시를 추가합니다. [https://www.mediawiki.org/wiki/Documentation/Style_guide]
    • 기술 문서 템플릿 및 제안사항에서 사용자 가이드, 방법 안내, 빠른 시작 가이드, 출시 노트 및 리드미 등의 특정 장르에 MediaWiki 관련 정보를 추가합니다. [https://www.mediawiki.org/wiki/Technical_documentation_templates_and_suggestions]
    • 기술 문서의 우선순위 지정 가이드라인을 테스트하고 개선합니다. [https://www.mediawiki.org/wiki/Technical_documentation_prioritization]
    • 다양한 장르의 문서를 위한 콘텐츠 수집 전략을 설계합니다.
    • MediaWiki 문서를 위한 커뮤니케이션 및 공동작업 전략을 설계합니다.
    • 작성자가 게시 전에 문서를 검토할 수 있는 체크리스트를 만듭니다.
    • 새로운 테크니컬 라이터를 위한 문서 구조를 확장합니다. [https://www.mediawiki.org/wiki/User:Pavithraes/Sandbox/New_Technical_Writers]
    • 해커톤에 적합한 기술 문서 작업 목록을 선별합니다. [https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons]
    • 유용한 리소스를 확인할 수 있는 테크니컬 라이터의 허브를 만듭니다.

  • MediaWiki의 동영상 제작자를 위한 문서 개선:

    • 일반 스크린캐스트를 만들기 위한 간단한 사용자 가이드를 만듭니다.
    • 둘러보기 및 튜토리얼을 위한 MediaWiki 전용 스크린캐스트 템플릿을 디자인합니다.

  • T214522 [https://phabricator.wikimedia.org/T214522]- '의사 소개' 스크린캐스트를 만듭니다.

2.3. 스트레칭 목표

  • 콘텐츠를 다시 확인하고 WikiProject 스크린캐스트 문서를 업데이트합니다. (https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Screencast)

3. 멘토

Zulip은 멘토와의 주요 커뮤니케이션 수단입니다. Wikimedia의 IRC 채널과 이메일은 커뮤니티와의 토론에 사용됩니다. 특정 작업에 대한 토론은 Phabricator 작업의 댓글 섹션에서 진행됩니다.

4. 토론

이 프로젝트는 크게 두 단계로 나뉩니다.

(i) Wikimedia의 테크니컬 라이터를 위한 기존 리소스를 개선합니다.

(ii) 잠재적 동영상 제작자를 위한 유용한 템플릿을 만듭니다.

(i) Wikimedia의 테크니컬 라이터를 위한 기존 리소스를 개선합니다.

이전에는 MediaWiki의 문서를 개선하기 위한 여러 이니셔티브가 성공의 정도에 따라 다양하게 이루어졌습니다. 다음과 같습니다...

  • https://www.mediawiki.org/wiki/User:Zakgreant/Tech_DocsPlan(2011--01/P6M)
  • https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan
  • https://www.mediawiki.org/wiki/Thread:Project:Current_issues/RestructureMediaWiki.org(or:_Document_how_it_was_and_execute_it)
  • https://www.mediawiki.org/wiki/User:Waldir/Docs

이러한 노력을 통해 테크니컬 라이터를 위한 더 나은 리소스 집합은 테크니컬 라이터가 작성하는 문서에 직접적인 영향을 미친다는 것을 알 수 있습니다.

다음은 Outreachy 2018 인턴의 안나 에 소(Anna e só) https://anna.flourishing.stream/2018/01/18/bringing-documentation-to-light/의 격주 보고서에서 발췌한 것입니다.

“MediaWiki의 스타일 가이드는 완벽하지 않습니다. 특히 가장 우수하다고 간주되는 관행을 강조하지 않고 외부 참조에 너무 많이 의존하기 때문입니다. 안타깝게도 이 문제는 MediaWiki에만 국한된 문제가 아닙니다. 번역 권장사항과 같은 다른 문서에도 언급되어 있기 때문입니다. 작가는 작업을 할 수 있는 양질의 신뢰할 수 있는 자원이 없어 타겟층을 정하고 적절한 글쓰기 스타일을 수립하는 데 어려움을 겪습니다. 또한 사용자, 특히 신규 사용자는 새로운 개념과 프로세스를 이해하는 데 어려움을 겪을 수 있습니다."

T197006 [https://phabricator.wikimedia.org/T197006] 은 또한 개선이 필요한 기술 문서 작성 문서의 특정 영역을 알려줍니다. Documentation/Style_guide는 시작에 좋은 출발점입니다.

더 나은 스타일 가이드가 완성되면 테크니컬 라이터들이 테크니컬 라이터의 다양한 단계를 거쳐가도록 안내하는 다음 문서들이 계획되어 있습니다. 문서는 초보자 친화적이어야 하며 동시에 작성자가 다시 참고하는 데 필요한 모든 정보를 제공해야 합니다.

준비 단계는 문서를 작성하는 토대를 마련하므로 가장 중요할 수 있습니다. 이 단계를 통해 기술 작성자를 지원하기 위해 관련 정보를 수집하는 몇 가지 효과적인 방법과 템플릿을 사용하여 이 정보를 구조화하는 방법에 대한 도움말을 설명하는 참조 문서를 개발합니다.

다음은 글쓰기 단계입니다. 작성자에게 자동으로 기준을 높게 설정하는 좋은 작업의 예시가 제공됩니다. 또한 모든 문서가 따라야 하는 기본 기준이 포함된 체크리스트를 만들 수 있습니다. 이렇게 하면 작성자가 게시하기 전에 문서를 검토하는 데 도움이 됩니다.

이러한 문서를 작성하더라도 새로운 테크니컬 라이터는 추가적인 도움이 필요할 수 있으므로 이를 지원해야 합니다. 새로운 테크니컬 라이터를 위한 가이드는 정교하게 다듬어졌으며, 해커톤에 적합한 작업 목록은 난이도를 기준으로 선별됩니다.

마지막으로 문서 관리 및 유지보수 프로세스를 이해하기 위한 문서인 '기술 문서 우선순위 지정'을 테스트하고 개선합니다.

이 단계가 끝나면 기술 문서 작성 가이드, 리소스, 예시, 제안 사항, 템플릿의 허브가 문서 스타일 가이드를 지원하는 역할을 합니다.

(ii) 잠재적 동영상 제작자를 위한 유용한 템플릿을 만듭니다.

"그래픽과 관련된 것을 배우는 가장 어려운 방법 중 하나는 일반 텍스트를 읽는 것입니다. 또한 매뉴얼에 잘못된 버전의 소프트웨어가 나오면 어떤 일이 벌어질지 상상해 보세요. 텍스트만 있는 매뉴얼에서는 평소에 사용하는 모든 신호가 없기 때문에 애플리케이션의 메뉴와 문구가 변경되면 일련의 작업을 재현하기가 불가능한 경우가 많습니다.

전문가가 바로 옆에 앉아 있을 때 학습하는 것이 가장 좋은 방법일 것입니다. 스크린캐스트는 정적인 그래픽과 전문가를 가까이 대하는 자리 사이에 있습니다. 친근한 목소리로 눈길을 끄는 시각적 데모를 만들 수 있고, 화면과 애니메이션에 텍스트 주석을 추가할 수도 있습니다. 전문가보다 스크린캐스트의 장점은 매일 매시간 언제든지 다시 볼 수 있다는 점입니다.

또한 스크린캐스트에 번역된 자막을 추가하여 모국어가 아닌 다른 사용자가 시청할 수 있도록 하거나 오디오 트랙을 대체 언어로 교체할 수 있습니다."

위 '스크린캐스팅 핸드북'[https://thescreencastinghandbook.com/wp-content/uploads/The_Screencasting_Handbook_rel10_20100502_v6.pdf]의 스니펫에서 Ian Ozsvald는 스크린캐스트의 중요성에 대해 설명합니다. 이는 MediaWiki 개발 환경 설정, 확장 프로그램 작성, Gerrit 사용 등에 대한 튜토리얼에 특히 유용할 수 있습니다.

문서 템플릿과 마찬가지로 스크린캐스트용 표준 템플릿을 사용하면 균일성이 향상되어 뷰어의 사용 환경이 개선됩니다. 또한 잠재적 동영상 예술가에게 시작하는 데 필요한 기본 틀도 제공합니다. 따라서 간단한 사용자 가이드와 소개 및 튜토리얼 동영상 제작을 위한 템플릿이 뒤따릅니다. 문서에는 다룰 개념의 깊이에 대한 포인터와 MediaWiki에 대한 몇 가지 스크린캐스트 아이디어가 포함되어 있습니다.

위 템플릿을 테스트하고 확장 목표를 준비하는 가장 좋은 방법은 도구와 템플릿을 사용하여 스크린캐스트를 만드는 것입니다. 따라서 Phabricator 사용의 기본사항을 다루는 'Introduction to Phabricator' 스크린캐스트가 제작되었습니다. 이 프로세스는 또한 논의가 필요한 영역을 강조표시합니다.

마지막으로 Wikimedia의 동영상 예술가를 위한 주요 참고 자료인 WikiProject 스크린캐스트가 검토 및 업데이트됩니다.

5. 잠정 타임라인

커뮤니티 활동 기간 (8월 1일~9월 1일)

  • 멘토와 함께 프로젝트를 자세히 분석해 보세요.

  • 다음에 관해 토론합니다.

    • 작업을 검토해야 하는 빈도입니다.
    • 일정을 공유하고 주간/일일 워크플로를 결정합니다.
    • 사용할 수 있는 도구와 리소스입니다.
    • 격주 및 일별 프로젝트 보고서

  • Phabricator에서 필수 할 일과 하위 할 일을 만듭니다.

  • 문서 개발 단계에서 개인적인 약속을 보완하기 위해 초안을 만듭니다.

1주차 (9월 2~8일)

  • 문서/Style_guide 개선:

    • MediaWiki의 모범 사례와 표준을 설명하는 데 주로 초점을 맞춥니다.
    • 모범 사례를 포함하고 관련 페이지의 가시성을 높입니다.

  • 신규 테크니컬 라이터를 위한 가이드 개선:

    • 문서 구조를 확장합니다.

2주차 (9월 9~15일)

  • 기술 문서 우선순위 지정 작업:

    • 문서 워크보드를 평가하고, 좋은 작업 설명 및 우선순위 지정의 예를 찾습니다.
    • 트렌드를 연구하고 일반적인 어려움을 기록합니다.
    • 정보와 예시를 활용해 우선순위 지정 표준을 문서화합니다.

3주차 (9월 16~22일)

  • 테크니컬 라이터를 위한 다음 추가 문서를 작성하세요.

    • 게시 전에 기술 문서를 검토하는 데 도움이 되는 체크리스트
    • 다양한 문서 장르의 콘텐츠를 효과적으로 수집하는 방법

4주차 (9월 23~29일)

  • 기술 문서 템플릿 및 제안사항에 가장 일반적인 MediaWiki 장르로 작성에 대한 정보를 추가합니다.

    • 사용자 가이드, 빠른 시작 가이드, 리드미, 출시 노트 및 사용 방법을 작성하기 위해 MediaWiki에서 모범 사례를 문서화합니다.

  • 기술적 커뮤니케이션의 성숙도를 높이기 위한 지침을 추가합니다. [https://www.mediawiki.org/wiki/User:SRodlund_(WMF)/Maturity_model_for_MediaWiki_technical_documentation#Increasingmaturity--_strategic_directions]

5주 차 (9월 30일~10월 6일)

  • 신규 공동작업자 온보딩을 위한 문서 개선:

    • 해커톤의 기술 문서 작업 페이지 업데이트 (할 일: 프로젝트 기간 동안 이 페이지에 적절한 작업 추가)

  • 테크니컬 라이터 허브 구축

    • 유용한 페이지 및 리소스로 연결되는 링크가 포함된 방문 페이지를 만듭니다.
    • 새 페이지와 기존 페이지 간에 쉽게 탐색할 수 있도록 필요한 링크를 추가합니다.

6주차 (10월 7~13일)

  • MediaWiki용 동영상 제작에 대한 다음 문서를 작성하세요.

    • 스크린캐스트 프로젝트를 가리키는 '일반 스크린캐스트 만들기'에 대한 간단한 사용자 가이드입니다.
    • 템플릿: 소프트웨어/도구 사용 안내, 새 도구 개발에 대한 자습서

  • MediaWiki를 위한 스크린캐스트 아이디어 목록을 만듭니다.

7주차 (10월 14~20일)

  • '의사 소개' 동영상 진행:

    • (지난 주에 만든) 템플릿을 사용하여 스크립트 초안을 작성합니다.
    • 템플릿의 효율성을 예측하고 필요한 경우 개선합니다.
    • 의견을 받고 초안을 완성하세요.

8주 차 (10월 21~27일)

  • 'Phabricator 소개' 동영상 게시:

    • 소프트웨어를 선택하여 설치합니다.
    • 환경을 설정하고 스크린캐스트를 만듭니다.
    • 발생한 문제와 해결 방법을 기록합니다.

9주 차 (10월 28일~11월 3일)

  • 스크린캐스트 프로젝트 문서를 개선합니다.

    • 구조를 살펴보고 변경이 필요한지 논의합니다.
    • 언급된 소프트웨어를 검토합니다.
    • 소프트웨어 목록을 조사하고 업데이트합니다.

10주 차 (11월 4~10일)

  • 계속해서 스크린캐스트 프로젝트 문서를 개선하세요.

    • 튜토리얼과 스크립트를 평가하고 개선합니다.
    • 스크린캐스트 갤러리를 검토합니다.

11주 차 (11월 11~17일)

  • 다음 스크린캐스트 프로젝트 문서를 작성합니다.

    • 최신 동영상을 찾아 갤러리에 추가합니다.
    • 필요한 구조를 변경합니다.

12주 차 (11월 18~24일)

  • 대기 중인 작업을 처리합니다.

  • 최종 보고서 작성:

    • 격주/일별 보고서를 참조하고 필요한 정보를 수집합니다.
    • 보고서 구조를 계획하고 초안을 작성합니다.
    • 멘토의 의견을 바탕으로 초안을 개선하고 완성합니다.

13주 차 (11월 25~29일)

  • 최종 보고서와 멘토 평가를 제출합니다.

6. 진도 추적

Zulip을 통해 멘토에게 일일 진행 상황 업데이트를 전달합니다. Wikimedia 커뮤니티에서 Phabricator나 격주 프로젝트 보고서를 통해 내 진행 상황을 추적할 수 있습니다.

7. 기타 약정

풀타임 대학생인데 가을 학기가 Docs 시즌 타임라인과 겹칩니다. 그래서 제 약속에는 대학 시험도 포함됩니다.

1차 내부 시험: 8월 18일~24일

2차 내부 시험: 9월 29일~10월 6일

학기 말 시험: 11월 11일~30일

또한 올해 유리한 장소 덕분에 10월 12일부터 15일까지 열리는 첫 번째 공개 컨퍼런스인 PyCon India에 참석할 계획입니다. 새로운 사람들을 만나고 유익한 대화를 나눌 수 있는 절호의 기회라고 생각합니다.

이러한 약정을 관리하기 위해 잠정 타임라인에는 해당 주에 덜 가중치가 부여된 작업이 포함됩니다. 문서 개발에 필요한 시간을 충분히 확보하기 위해 가을 학기에 핵심 크레딧을 20개 이하로 이수하려고 합니다. (일반 학생은 학기당 평균 25학점 이수)