이 페이지에는 Google Season of Docs에서 수락된 기술 작문 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Zulip 오픈소스팀 채팅
- 테크니컬 라이터:
- 드로사
- 프로젝트 이름:
- ReadTheDocs 및 API 문서 리팩터링
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
두 분야에 집중하여 동시에 작업할 것입니다. 그중 하나는 zulip.readthedocs.io의 품질을 개선하여 신규 참여자가 이 과정에서 혼란과 의구심을 줄일 수 있도록 하는 것입니다. 첫 참여부터 Zulip의 작동 방식에 익숙해지는 데 이르기까지 명확하고 간결한 과정을 갖추는 것이 가장 좋습니다. 또한 추가 엔드포인트를 문서화하는 프로세스를 더 쉽게 이해할 수 있도록 zulipchat.com/api, api.md, openapi.md 관련 작업을 할 계획입니다. 두 부분 모두 콘텐츠 업데이트/단순화, 어수선한 기사 정리, 누락된 개발자 문서 추가, 코드 작성/테스트를 포함할 가능성이 높습니다.
프로젝트는 4단계로 구성됩니다. 첫 번째 단계에는 소규모 숙지 프로젝트, 준비 도구, 현재 문서화 요구사항에 대한 보다 나은 이해가 포함됩니다. 두 번째 단계의 목적은 이번 가을에 Zulip의 목표 맥락에서 업무를 구성하고, 지정하고, 우선순위를 정하는 것입니다. 그런 다음 프로젝트의 구현 단계로 넘어가겠습니다. 저는 멘토 및 Zulip의 다른 개발자 커뮤니티와 의견을 주고받으며 의견을 구할 것입니다. 마지막 단계는 되돌아봤을 때 필요한 부분을 수정하고, 프로젝트 보고서를 작성하는 것입니다.
핵심 개발자의 결정을 포함하여 다른 사람이 하는 일로 인해 업무 기간 동안 일부 우선순위와 작업이 변경될 가능성이 있습니다. 이러한 변화에 잘 적응하는 방법을 배우는 것이 성공적인 GSoD 경험을 위해 반드시 필요한 측면이 될 것입니다. 제안된 아이디어를 나중으로 미룰 수 있습니다. 대체로 저는 Zulip 오픈소스 프로젝트의 전반적인 성공에 가치를 제공하는 데 중점을 둘 것입니다.