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ở:
- 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 cho việc áp dụng đối tượng chung, Liên kết Python động và Hướng dẫn
- Thời lượng dự án:
- Sử dụng lâu dài (5 tháng)
Mô tả dự án
CERN-HSF – Tài liệu về ROOT cho việc áp dụng đối tượng chung, Liên kết động Python và Hướng dẫn cố vấn: Olivier Couet, Axel Nauman
Tóm tắt: Tài liệu là yếu tố cần thiết để người dùng sử dụng phần mềm thành công và hiệu quả. Tài liệu rõ ràng, chính xác và toàn diện dành cho người dùng giúp tạo điều kiện để người dùng thành thạo sử dụng phần mềm khi họ nỗ lực hướng tới mục tiêu của mình. Cùng với đó, các ví dụ và hướng dẫn rõ ràng là công cụ mạnh mẽ giúp người dùng học nhanh bằng cách sử dụng.
Khi xem xét việc sử dụng ROOT của các nhà vật lý, nhà nghiên cứu và nhà phát triển trong không gian phân tích dữ liệu và trực quan hoá dữ liệu cho vật lý, chúng ta đã nhận thấy sự công nhận về lợi ích của các tài liệu mới cập nhật và thân thiện với người dùng. Cụ thể, do độ rộng của mã nguồn và sự phát triển của nó, hệ thống tài liệu sẽ được hưởng lợi từ việc phát triển song song để cấp cho người dùng khả năng khai thác tối đa tất cả những gì 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 hướng dẫn cho phép các nhà vật lý áp dụng ROOT dễ dàng 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 động Python, chúng tôi có thể cải tiến để tài liệu toàn diện và rõ ràng hơn. Tương tự, định dạng dữ liệu mới RNTuple thiếu 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 bị thiếu 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 ngành và đối tượng chung, tạo tài liệu để thu hẹp khoảng cách đó, viết một tài liệu chi tiết hơn về Dynamic Python Bindings, thực hiện “hướng dẫn phân tích hiện đại” cho ROOT 7 và tạo thông số kỹ thuật chi tiết cho RNTuple. Ngoài ra, trong quá trình này, tài liệu có thể kết hợp sổ tay Jupyter để các công cụ học tập hữu hình và tương tác có thể hỗ trợ người dùng.
Tiến trình: Các giai đoạn của dự án được ước tính là: Xác định lỗ hổng kiến thức giữa các nhà nghiên cứu chuyên ngành và đối tượng nói chung (trong khi đọc tài liệu hiện tại và mã nguồn) → 1-2 tuần Tạo và tái cấu trúc tài liệu để thu hẹp khoảng cách đó → 3 tuần Viết tài liệu chi tiết hơn về Liên kết Dynamic Python → 3 tuần Triển khai hướng dẫn chi tiết cho liên kết Dynamic Python → 3 tuần R Triển khai hướng dẫn kỹ thuật cho ROOT 7 tuần đã hoàn tất → 1 tuần
Sản phẩm và nguyên tắc để gặt hái thành công: Tài liệu hợp nhất dành cho người dùng mà không bị thiếu thông tin Tài liệu người dùng được cập nhật đầy đủ để phản ánh các tính năng mới nhất, tức là các lớp dẫn xuất mới Hướng dẫn thông qua sổ tay Jupyter