이 페이지에는 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 오픈소스 프로젝트의 전반적인 성공에 가치를 가져오는 데 중점을 둘 것입니다.