Dự án CERN-HSF

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 Phần Google 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:
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:
Lâu dài (5 tháng)

Mô tả dự án

Dự án có mục tiêu cải thiện tài liệu về ROOT, là hệ thống phần mềm chính để phân tích dữ liệu và trình bày dữ liệu được 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 & 7) và tôi có kiến thức về các thành phần khác theo yêu cầu của dự án, 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 3 yếu tố chính trong tài liệu về 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

Dường như với tôi, tài liệu về ROOT ("hướng dẫn sử dụng ROOT") mới cần được cải thiện và bổ sung trong những khía cạnh sau:

  • Tài liệu này sẽ trở nên dễ tiếp cận và dễ hiểu hơn đối với những người không phải nhà vật lý, đặc biệt là các chương giới thiệu.
  • Sẽ được 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 đính kèm với nội dung mô tả và ví dụ chi tiết. Tôi có thể liệt kê trong số đó:
    • Liên kết Python
    • Thư viện toán học
    • Phần mô tả thủ công cho 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 chính mới (RDataFrame và RNtuple) cần có thông số kỹ thuật và hướng dẫn 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. Điều này đòi hỏi bạn phải phân tích chi tiết các 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 phần 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

Lịch biểu thời gian dự kiến (5 tháng):

  • Giai đoạn 1: Định nghĩa nhiệm vụ và phạm vi của 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âu hỏi của người dùng quan trọng từ 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 muốn nói thêm rằng tôi đã đóng góp cho tài liệu ROOT vào năm ngoái thông qua một dự án dài hạn về Phần Tài liệu trên Google. Tôi đã xác định cấu trúc mới của Sổ tay hướng dẫn. Đề xuất năm nay sẽ góp phần hoàn thiện các khía cạnh khác về tài liệu vẫn còn thiếu trong ROOT.