Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Open3D
- Người viết nội dung kỹ thuật:
- Rohan Rathi
- Tên dự án:
- Tài liệu kỹ thuật về API Python và C++
- Thời lượng dự án:
- Thời lượng tiêu chuẩn (3 tháng)
Mô tả dự án
Bản tóm tắt:
Dự án này sẽ được chia thành 4 phần: Nâng cấp và mở rộng hướng dẫn của người đóng góp Open3D Hoàn thành tài liệu về API Python Hoàn thành tài liệu về API C++ Tài liệu cấp cao về cấu trúc dữ liệu cốt lõi
Nội dung mô tả:
Trong dự án của mình, tôi dự định chia dự án này thành 4 phần:
Tôi dự định hoàn thành và cập nhật hướng dẫn dành cho cộng tác viên cho người mới tham gia, trong đó cung cấp hướng dẫn từng bước toàn diện về cách họ có thể tạo mã nguồn, xây dựng tài liệu và tham gia cộng đồng nhà phát triển. Ngoài phần hướng dẫn bằng văn bản, tôi dự định tạo một video trình bày các bước chính xác về cách tạo mã nguồn cho kênh youtube. Tôi cũng sẽ thêm hướng dẫn về cách các nhà phát triển mới có thể đóng góp vào tài liệu này thông qua việc thay đổi mã nguồn do Sphinx tạo bằng pybind và doxygen.
Mở rộng tài liệu về API Python. Hiện tại, API Python chứa các chuỗi tài liệu cơ bản cho các lớp và các hàm thành phần cung cấp nội dung mô tả không rõ ràng về chức năng này. Tôi dự định diễn đạt lại tài liệu về API Python để API này dễ hiểu hơn và chức năng rõ ràng hơn. Tôi cũng có ý định thêm đường liên kết đến các khái niệm đồ hoạ 3D có liên quan được sử dụng trong nhiều khu vực (Ví dụ: Ma trận nội tại được sử dụng trong Máy ảnh)
Hoàn tất tài liệu về API C++. Hiện tại, không có chuỗi tài liệu nào tương đương trong tài liệu C++ so với tài liệu Python. Tôi có ý định ghi lại chi tiết các lớp cũng như hàm thành phần và thành phần dữ liệu có liên quan của chúng .
Tài liệu cấp cao và cấp thấp về cấu trúc dữ liệu cốt lõi. Tôi dự định sẽ tìm hiểu mã của các cấu trúc dữ liệu khác nhau, chẳng hạn như TriangleMesh, LineSet, Octree và thêm nhận xét vào cơ sở mã, cho cả hai mục đích để nhà phát triển mới hiểu và mọi người dùng. Đồng thời, cung cấp tài liệu cấp cao về cách sử dụng và các khái niệm có liên quan đến cấu trúc bằng cách cải thiện các hướng dẫn. Tôi sẽ cung cấp các ví dụ chi tiết về cách sử dụng và thêm các đường liên kết phù hợp đến các khái niệm có liên quan đến cấu trúc. Nếu có thời gian, tôi sẽ làm những công việc đơn giản hơn như ghi lại cách thực hiện một số công việc có thể giúp những người dùng mới liên kết với phần mềm.
Lịch biểu dự án-
1/8 — 1/9:
Làm quen với người cố vấn và thảo luận sâu hơn về cấp độ tài liệu cần thiết ở các phần khác nhau của cơ sở mã, đồng thời thảo luận chi tiết về mức độ cần thiết đối với tài liệu cấp thấp và cấp cao. Tôi cũng sẽ dành thời gian này để tìm hiểu cơ sở mã và nghiên cứu các khái niệm để có thể ghi chép chúng tốt hơn.
Tuần 1 và 2:
Tôi sẽ cập nhật và mở rộng hướng dẫn dành cho cộng tác viên. Tôi sẽ cải thiện tài liệu về cách tạo mã nguồn. Tôi cũng sẽ thêm một phần tài liệu về cách các cộng tác viên mới có thể giúp đỡ bạn trong việc tạo tài liệu. Tôi cũng sẽ tạo một video trên YouTube nêu rõ cách tạo mã nguồn theo từng bước.
Tuần 3 – 5:
Tôi sẽ tìm cách mở rộng API Python. Diễn đạt lại tài liệu hiện có và viết tài liệu chi tiết về các thành viên hiện tại. Tôi cũng sẽ thêm đường liên kết phù hợp đến các khái niệm có liên quan để người dùng có thể tự làm quen với các khái niệm có liên quan.
Tuần 6 – 8:
Các tài liệu C++ hiện tại chưa hoàn chỉnh đối với hầu hết các phần của thư viện, vì vậy tôi sẽ dành phần lớn thời gian để điền vào tài liệu C++
Tuần 9 – 11:
Trong giai đoạn này, tôi sẽ làm việc về các cấu trúc dữ liệu cốt lõi. Sắp xếp lại các hướng dẫn về từng cấu trúc dữ liệu, cung cấp thông tin tổng quan cũng như ghi lại thông tin chi tiết về cách sử dụng mẫu.
Tuần cuối cùng:
Tôi sẽ dùng tuần cuối cùng để chuẩn bị báo cáo cuối cùng về công việc đã thực hiện trong 12 tuần làm tài liệu. Tôi cũng sẽ dành thời gian để xem xét và hoàn thiện tài liệu.