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