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ở:
- CERN-HSF
- Người viết nội dung kỹ thuật:
- John
- Tên dự án:
- CERN-HSF – Tài liệu về ROOT để sử dụng cho đối tượng chung, liên kết Python động và hướng dẫn
- Thời lượng dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
CERN-HSF – Tài liệu ROOT để sử dụng cho đối tượng chung, liên kết Python động và hướng dẫn Người cố vấn: Olivier Couet, Axel Naumann
Tóm tắt: Tài liệu là yếu tố thiết yếu để người dùng sử dụng phần mềm một cách thành công và hiệu quả. Tài liệu người dùng rõ ràng, chính xác và toàn diện giúp người dùng sử dụng thành thạo phần mềm khi họ nỗ lực đạt được mục tiêu của mình. Cùng với đó, các ví dụ và hướng dẫn rõ ràng đóng vai trò là công cụ hữu ích để người dùng có thể nhanh chóng tìm hiểu.
Khi chúng tôi kiểm tra việc các nhà vật lý, nhà nghiên cứu và nhà phát triển sử dụng ROOT trong không gian phân tích và trực quan hoá dữ liệu cho vật lý, chúng tôi nhận thấy lợi ích của tài liệu được cập nhật và thân thiện với người dùng. Cụ thể, do phạm vi của mã nguồn và sự phát triển của mã nguồn, hệ thống tài liệu sẽ được hưởng lợi từ việc phát triển song song để cho phép người dùng khai thác tối đa mọi tính năng mà ROOT cung cấp.
Tóm tắt và phân tích tài liệu hiện tại Hiện tại, tài liệu người dùng cung cấp một hướng dẫn giúp các nhà vật lý dễ dàng sử dụng ROOT hơn so với đối tượng chung. Hơn nữa, trong một số chủ đề nhất định như Liên kết Python động, bạn có thể cải thiện tài liệu để tài liệu trở nên toàn diện và rõ ràng hơn. Tương tự, định dạng dữ liệu mới RNTuple thiếu các thông số kỹ thuật chi tiết cần thiết. Cuối cùng, tài liệu hiện tại thiếu các hướng dẫn liên quan đến ROOT 7.
Phương pháp: Sau khi trao đổi với Olivier, có vẻ như để giải quyết các vấn đề nêu trên, trọng tâm chính sẽ liên quan đến việc xác định lỗ hổng kiến thức giữa các nhà nghiên cứu chuyên biệt và đối tượng chung, tạo tài liệu để thu hẹp khoảng cách đó, viết tài liệu chi tiết hơn về Liên kết Python động, triển khai các "hướng dẫn cho phương pháp phân tích hiện đại" cho ROOT 7 và tạo các thông số kỹ thuật chi tiết cho RNTuple. Cùng với đó, trong quá trình này, tài liệu có thể kết hợp với sổ tay Jupyter để các công cụ học tập hữu hình và tương tác có thể giúp người dùng.
Tiến trình: Theo dự kiến, dự án sẽ trải qua các giai đoạn sau: Xác định khoảng trống kiến thức giữa các nhà nghiên cứu chuyên sâu và đối tượng người dùng chung (trong khi đọc tài liệu và mã nguồn hiện tại) → 1-2 tuần Tạo và tái cấu trúc tài liệu để thu hẹp khoảng trống đó → 3 tuần Viết tài liệu chi tiết hơn về Dynamic Python Bindings → 3 tuần Triển khai hướng dẫn cho Dynamic Python Bindings → 3 tuần Triển khai hướng dẫn cho ROOT 7 → 4 tuần Tạo thông số kỹ thuật chi tiết cho RNTuple → 3 tuần Xem xét các mục tiêu dự án đã hoàn thành thành công → 1 tuần
Sản phẩm và nguyên tắc để thành công: Tài liệu người dùng hợp nhất duy nhất mà không có bất kỳ khoảng trống nào Tài liệu người dùng được cập nhật hoàn toàn để phản ánh các tính năng mới nhất, tức là các lớp phái sinh mới Hướng dẫn thông qua sổ ghi chú Jupyter