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:
- LuckInTheRain
- Tên dự án:
- Mở rộng và cải thiện tài liệu về ROOT
- Thời lượng dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
Dự án này nhằm mục đích cải thiện tài liệu về ROOT, hệ thống phần mềm chính để phân tích và trình bày dữ liệu mà cộng đồng vật lý năng lượng cao trên toàn thế giới sử dụng.
Ngoài các kỹ năng viết kỹ thuật mà tôi có thể cung cấp cho dự án, tôi cũng quen thuộc với ROOT (6 và 7) và có kiến thức về các thành phần khác mà dự án yêu cầu, chẳng hạn như:
- C++
- Python
- Git/GitHub
- Công cụ xây dựng trang web (html, markdown, Jekyll)
Tôi xác định được 3 phần chính trong tài liệu ROOT:
- trang web https://root.cern,
- hướng dẫn tham khảo lớp C++ https://root.cern/doc/master/,
- diễn đàn https://root-forum.cern.ch
Tôi thấy tài liệu về ROOT ("hướng dẫn ROOT" mới) cần được cải thiện và bổ sung ở những khía cạnh sau:
- Sách này sẽ dễ tiếp cận và dễ hiểu hơn đối với những người không phải là nhà vật lý, đặc biệt là các chương mở đầu.
- Chúng tôi sẽ phát triển thêm các hướng dẫn giải thích chức năng chung của ROOT.
- Một số chủ đề và nội dung phát triển mới sẽ được đưa vào cùng với nội dung mô tả và ví dụ chi tiết.
Trong số những hành động tôi có thể liệt kê:
- Liên kết Python
- Thư viện toán học
- Nội dung mô tả thủ công đối với các công cụ đồ hoạ cấp cao (TRatioPLot, THStack)
- Các công cụ phân tích khai thác dữ liệu mới (RDataFrame và RNtuple)
- Các định dạng dữ liệu khoá mới (RDataFrame và RNtuple) cần có hướng dẫn và thông số kỹ thuật chi tiết.
Câu trả lời cho các câu hỏi quan trọng của người dùng, chẳng hạn như những câu hỏi được đăng trong diễn đàn ROOT, sẽ cần được đưa vào tài liệu. Để làm được như vậy, bạn phải phân tích chi tiết những câu hỏi thường gặp nhất, sau đó là giai đoạn tổng hợp để dịch chúng thành các nội dung tài liệu trong "Hướng dẫn sử dụng ROOT" mới hoặc trong một số hướng dẫn mới trong Hướng dẫn tham khảo.
Hướng dẫn minh hoạ các chức năng do ROOT 7 cung cấp.
- Biểu đồ ROOT 7 mới
- Đồ hoạ ROOT 7 mới
Tiến trình dự kiến (5 tháng):
- Giai đoạn 1: Định nghĩa các nhiệm vụ và phạm vi đối với tài liệu và hướng dẫn về ROOT: 2 tuần.
- Giai đoạn 2: Thu thập và phân tích các câu hỏi quan trọng của người dùng trên diễn đàn ROOT: 2 tuần
- Giai đoạn 3: Viết tài liệu ROOT: 8 tuần.
- Giai đoạn 4: Phát triển hướng dẫn: 8 tuần
Cuối cùng, tôi cũng muốn bổ sung rằng tôi đã đóng góp cho tài liệu ROOT vào năm ngoái thông qua dự án Google Season of Docs dài hạn. Tôi đã xác định cấu trúc mới của Hướng dẫn. Đề xuất trong năm nay sẽ góp phần hoàn thiện các khía cạnh tài liệu khác vẫn còn thiếu trong ROOT.