이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Open3D
- 기술 문서 작성자:
- 로한 라티
- 프로젝트 이름:
- Python 및 C++ API 기술 문서
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
줄거리:
프로젝트는 다음 네 부분으로 나뉩니다. Open3D 참여자 가이드 업그레이드 및 확장 Python API 문서 작성 C++ API 문서 작성 핵심 데이터 구조에 대한 고급 문서
설명:
이 프로젝트에서는 프로젝트를 네 부분으로 나눌 계획입니다.
소스 코드를 빌드하고, 문서를 빌드하고, 개발자 커뮤니티에 참여하는 방법을 단계별로 종합적으로 안내하는 신규 참여자를 위한 참여자 가이드를 완료하고 업데이트할 계획입니다. 서면 가이드와 더불어 YouTube 채널의 소스 코드를 빌드하는 방법을 정확히 설명하는 동영상을 만들고 싶습니다. 또한 신규 개발자가 pybind 및 doxygen을 사용하여 sphinx로 빌드된 소스 코드를 변경하여 문서에 기여하는 방법에 관한 가이드를 추가할 예정입니다.
Python API 문서를 확장합니다. 현재 Python API에는 기능에 관한 모호한 설명을 제공하는 클래스 및 구성원 함수의 기본 docstring이 포함되어 있습니다. API를 더 쉽게 이해하고 기능을 더 명확하게 설명할 수 있도록 Python API 문서를 수정할 계획입니다. 또한 다른 영역에서 사용되는 관련 3D 그래픽 개념 (예: 카메라에 사용되는 내부 매트릭스)에 대한 링크를 추가할 예정입니다.
C++ API 문서를 작성합니다. 현재 C++ 문서에는 Python 문서에 비해 상응하는 docstring이 없습니다. 클래스와 관련 멤버 함수 및 데이터 멤버를 자세히 문서화하려고 합니다 .
핵심 데이터 구조에 관한 상위 및 하위 문서입니다. TriangleMesh, LineSet, Octree와 같은 다양한 데이터 구조의 코드를 이해하고 코드베이스에 주석을 추가하여 신규 개발자와 모든 사용자를 위해 이해를 돕고자 합니다. 또한 튜토리얼을 개선하여 구조와 관련된 사용 및 개념에 관한 대략적인 문서를 제공합니다. 사용 예를 자세히 설명하고 구조와 관련된 개념에 관한 관련 링크를 추가하겠습니다. 시간이 허락하는 경우 신규 사용자가 소프트웨어와 제휴하는 데 도움이 되는 특정 작업을 실행하는 방법을 문서화하는 등 더 간단한 작업을 진행할 예정입니다.
프로젝트 일정 -
8월 1일~9월 1일:
멘토와 친해지고 코드베이스의 여러 부분에 필요한 문서 수준을 자세히 논의하고, 또한 하위 수준 문서와 상위 수준 문서를 얼마나 심층적으로 다룰지 논의합니다. 또한 이 시간 동안 코드베이스를 이해하고 개념을 연구하여 더 나은 문서를 작성할 수 있도록 하겠습니다.
1주차 및 2주차:
참여자 가이드를 업데이트하고 확장하겠습니다. 소스 코드를 빌드하는 방법에 관한 문서를 개선하겠습니다. 신규 참여자가 문서 작성에 어떻게 도움을 줄 수 있는지에 관한 문서 작성자 섹션도 추가할 예정입니다. 소스 코드를 빌드하는 방법을 단계별로 설명하는 YouTube 동영상도 만들겠습니다.
3~5주차:
Python API 확장을 진행하겠습니다. 기존 문서를 수정하고 기존 회원의 문서를 자세히 작성합니다. 또한 사용자가 관련 개념을 더 잘 이해할 수 있도록 관련 개념에 관한 링크도 추가할 예정입니다.
6~8주 차:
현재 C++ 문서는 라이브러리 대부분이 불완전하므로 C++ 문서를 작성하는 데 대부분의 시간을 할애하겠습니다.
9~11주 차:
이 기간 동안 핵심 데이터 구조를 작업할 예정입니다. 각 데이터 구조의 튜토리얼을 재구성하고 대략적인 개요와 사용 예시 세부정보를 문서화합니다.
최종 주:
마지막 주에는 12주간의 문서화 기간 동안 수행한 작업에 관한 최종 보고서를 준비하겠습니다. 이 시간 동안 문서를 검토하고 마무리할 예정입니다.