Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
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 hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Bản tóm tắt:
Dự án sẽ được chia thành 4 phần: Nâng cấp và mở rộng hướng dẫn dành cho cộng tác viên Open3D Tài liệu đầy đủ về API Python Tài liệu đầy đủ về API C++ Tài liệu cấp cao về cấu trúc dữ liệu cốt lõi
Mô tả:
Trong dự án của mình, tôi dự định chia dự án thành 4 phần:
Tôi dự định hoàn tất và cập nhật hướng dẫn dành cho cộng tác viên dành cho người mới. Hướng dẫn này sẽ 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, tạo tài liệu và tham gia cộng đồng nhà phát triển. Ngoài hướng dẫn bằng văn bản, tôi dự định tạo một video trình bày chính xác các bướ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 cho tài liệu bằng cách thực hiện các thay đổi đối vớ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 ký tự cơ bản cho các lớp và hàm thành viên cung cấp nội dung mô tả mơ hồ về chức năng. Tôi dự định sẽ diễn đạt lại tài liệu về API Python để giúp API dễ hiểu hơn và chức năng rõ ràng hơn. Tôi cũng dự đị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 lĩnh 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 dự định ghi lại chi tiết các lớp và các hàm thành viên và thành viên dữ liệu liên kết của các lớp đó .
Tài liệu cấp cao và cấp thấp về các cấu trúc dữ liệu cốt lõi. Tôi dự định tìm hiểu mã của nhiều cấu trúc dữ liệu như TriangleMesh, LineSet, Octree và thêm chú thích vào cơ sở mã, cả để 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 liên quan đến cấu trúc bằng cách cải thiện 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 có liên quan đến các khái niệm liên quan trong cấu trúc. Nếu có thời gian, tôi sẽ làm những việc đơn giản hơn như ghi lại cách thực hiện một số thao tác nhất định có thể giúp người dùng mới làm quen 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 của tôi 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 về mức độ chi tiết trong tài liệu cấp thấp so với tài liệu 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 lại 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 dành cho người viết tài liệu về cách những người đóng góp mới có thể giúp đỡ trong việc viết tài liệu. Tôi cũng sẽ tạo một video trên youtube chỉ rõ từng bước cách tạo mã nguồn.
Tuần 3 – 5:
Tôi sẽ làm việc để mở rộng API Python. Viế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 phần hiện có. Tôi cũng sẽ thêm các đường liên kết liên quan đến các khái niệm liên quan để người dùng có thể làm quen tốt hơn với các khái niệm liên quan.
Tuần 6 – 8:
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 khoảng thời gian này, tôi sẽ tập trung vào các cấu trúc dữ liệu cốt lõi. Điều chỉnh cấu trúc hướng dẫn của từng cấu trúc dữ liệu, cung cấp thông tin tổng quan cấp cao cũng như ghi lại thông tin chi tiết về cách sử dụng ví dụ.
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 đã hoàn thành trong khoảng thời gian 12 tuần làm tài liệu. Tôi cũng sẽ dành thời gian này để xem xét và hoàn thiện tài liệu.