이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Open3D
- 테크니컬 라이터:
- 로한 라티
- 프로젝트 이름:
- Python 및 C++ API 기술 문서
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
줄거리:
프로젝트는 4개 부분으로 나뉩니다. 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주간의 문서 작성 기간 동안 완료된 작업에 대한 최종 보고서를 준비하겠습니다. 또한 문서 검토 및 마무리 작업에도 시간을 할애하겠습니다.