이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Wikimedia Foundation 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 구성:: Wikimedia Foundation
테크니컬 라이터:: 파비트라 에스와라무르티
프로젝트 이름:: 위키미디어의 기술 문서 작성자 및 동영상 제작자를 위한 문서 개선
프로젝트 길이:: 표준 기간 (3개월)

Project description

1. 내 정보

몇 개월 전 오픈소스 소프트웨어를 처음 접했을 때는 그 무한한 범위에 압도당했습니다. 수많은 프로젝트를 진행하는 과정에서 고군분투하던 중에 Google 프로그래밍 경진대회(Summer of Code) 및 공익사업과 같은 오픈소스 이니셔티브에 대해 알게 되었습니다. Google Docs 시즌이 흥미로워 보였고 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]- 'Phabricator 소개' 스크린캐스트를 만듭니다.

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

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

다음은 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) 잠재적인 동영상 제작자를 위한 유용한 템플릿을 만듭니다.

"그래픽과 관련된 내용을 배우는 가장 어려운 방법 중 하나는 일반 텍스트를 읽는 것입니다. 매뉴얼에 잘못된 버전의 소프트웨어가 언급되는 경우를 생각해 보세요. 텍스트 전용 매뉴얼의 경우 일반적으로 사용하는 모든 신호가 없으므로 애플리케이션의 메뉴와 문구가 변경되면 일련의 작업을 재현할 수 없는 경우가 많습니다.

전문가가 바로 옆에 있으면 가장 효과적으로 학습할 수 있습니다. 스크린캐스트는 정적인 그래픽과 전문가의 가까이에 있는 사이에 놓입니다. 친근한 음성으로 시각적인 데모가 제공되며 화면과 애니메이션에 텍스트 주석을 추가할 수도 있습니다. 전문가에 비해 스크린캐스트의 장점은 매일 매시간 마음대로 다시 볼 수 있다는 것입니다.

원어민이 아닌 사용자가 볼 수 있도록 번역된 자막을 스크린캐스트에 추가하거나 오디오 트랙을 다른 언어로 대체할 수도 있습니다."

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

문서 템플릿과 마찬가지로 스크린캐스트용 표준 템플릿을 사용하면 일관성이 높아져 시청자 경험이 개선됩니다. 또한 잠재적인 동영상 제작자에게 시작할 수 있는 프레임워크를 제공합니다. 따라서 시작 동영상 및 튜토리얼 동영상을 만들기 위한 템플릿이 포함된 빠른 사용자 가이드가 개발되었습니다. 이 문서에는 다룰 개념의 심도에 관한 도움말과 MediaWiki용 스크린캐스트 아이디어가 몇 가지 포함되어 있습니다.

위 템플릿을 테스트하고 확장 목표를 준비하는 가장 좋은 방법은 도구와 템플릿을 사용하여 스크린캐스트를 만드는 것입니다. 따라서 Phabricator 사용의 기본사항을 다루는 'Phabricator 소개' 스크린캐스트가 만들어집니다. 이 과정에서 논의가 필요한 영역도 강조 표시됩니다.

마지막으로, Wikimedia의 비디오 제작자가 참고할 수 있는 중심 출처인 WikiProject 스크린캐스트를 검토하고 업데이트합니다.

5. 잠정 타임라인

커뮤니티 결속 기간 (8월 1일~9월 1일)

멘토와 함께 프로젝트를 자세히 분석합니다.
토론 주제:
- 태스크를 검토해야 하는 빈도입니다.
- 일정을 공유하고 주간/일별 워크플로를 결정합니다.
- 사용할 수 있는 도구 및 리소스
- 주간 및 일간 프로젝트 보고서
Phabricator에서 필요한 작업과 하위 작업을 만듭니다.
문서 개발 단계에서 개인적인 약속을 보상하기 위해 초안을 만듭니다.

1주 차 (9월 2~8일)

Documentation/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일)

""Pabricator 소개"" 동영상 작업:
- 이전 주에 만든 템플릿을 사용하여 스크립트 초안을 작성합니다.
- 템플릿의 효율성을 추정하고 필요한 경우 개선합니다.
- 의견을 받고 초안을 수정합니다.

8주차 (10월 21~27일)

'Pabricator 소개' 동영상을 게시합니다.
- 소프트웨어를 선택하고 설치합니다.
- 환경을 설정하고 스크린캐스트를 만듭니다.
- 발생한 문제와 해결 방법을 기록합니다.

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

스크린캐스트 프로젝트 문서를 개선하기 위해 노력합니다.
- 구조를 검토하고 변경이 필요한지 논의합니다.
- 언급된 소프트웨어를 검토합니다.
- 소프트웨어 목록을 조사하고 업데이트합니다.

10주차 (11월 4~10일)

Screencast 프로젝트 문서를 계속 개선합니다.
- 튜토리얼과 스크립트를 평가하고 개선합니다.
- 스크린캐스트 갤러리를 검토합니다.

11주 차 (11월 11~17일)

스크린캐스트 프로젝트 문서 작업을 완료합니다.
- 최신 동영상을 찾아 갤러리에 추가합니다.
- 필요한 구조적 변경사항을 적용합니다.

12주 차 (11월 18~24일)

대기 중인 작업을 처리합니다.
최종 보고서를 작성합니다.
- 격주/일별 보고서를 참고하여 필요한 정보를 수집합니다.
- 보고서 구조를 계획하고 초안을 작성합니다.
- 멘토의 의견을 바탕으로 초안을 개선하고 마무리합니다.

13주차 (11월 25~29일)

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

6. 진도 확인

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

7. 기타 약정

저는 정규 대학 학생인데, 가을 학기가 Docs 시즌 타임라인과 겹칩니다. 그래서 대학 시험도 빼놓을 수 없죠.

첫 번째 내부 시험: 8월 18~24일

두 번째 내부 시험: 9월 29일~10월 6일

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

올해는 좋은 위치에 있어 10월 12일부터 15일까지 첫 공개 컨퍼런스인 PyCon India에도 참석할 계획입니다. 새로운 사람들을 만나고 유익한 대화를 나눌 수 있는 좋은 기회가 될 것입니다.

이러한 약정을 관리하기 위해 잠정 타임라인에는 해당 주의 덜 중요한 작업이 포함됩니다. 문서 개발에 충분한 시간을 확보하기 위해 가을 학기에는 핵심 학점 20개 이하를 완료할 계획입니다. (일반 학생은 학기당 평균 25학점 완료)