CERN-HSF 프로젝트

이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
CERN-HSF
테크니컬 라이터:
LuckInTheRain
프로젝트 이름:
루트 확장 및 개선 문서
프로젝트 기간:
장기 실행 (5개월)

Project description

이 프로젝트의 목표는 전 세계 고에너지 물리학 커뮤니티에서 사용하는 데이터 분석 및 데이터 프레젠테이션을 위한 주요 소프트웨어 시스템인 ROOT의 문서를 개선하는 것입니다.

프로젝트를 위해 제공할 수 있는 테크니컬 라이터 기술 외에 루트 (6 및 7)에 대해서도 잘 알고 있으며 프로젝트에 필요한 다음과 같은 다른 구성요소에 대해서도 알고 있습니다.

  • C++
  • Python
  • Git/GitHub
  • 웹사이트 구축 도구 (html, 마크다운, Jekyll)

ROOT 문서에서 세 가지 주요 요소를 확인합니다.

  • https://root.cern,
  • C++ 클래스 참조 가이드 https://root.cern/doc/master/
  • 포럼 https://root-forum.cern.ch

다음 영역에서 ROOT 문서('루트 매뉴얼')를 개선하고 보완해야 할 것 같습니다.

  • 특히 입문 장에서 물리학자가 아닌 사람도 더 쉽게 접근하고 이해할 수 있어야 합니다.
  • 더 많은 튜토리얼에서 ROOT의 일반적인 기능을 설명해야 합니다.
  • 몇 가지 새로운 주제와 개발 내용이 자세한 설명과 예시와 함께 포함됩니다. 그중 일부를 소개하면 다음과 같습니다.
    • Python 바인딩
    • 수학 라이브러리
    • 상위 그래픽 도구에 대한 수동 설명 (TRatioPLot, THStack)
    • 새로운 데이터 마이닝 분석 도구 (RDataFrame 및 RNtuple)
  • 새로운 키 데이터 형식 (RDataFrame 및 RNtuple)에는 자세한 기술 사양과 튜토리얼이 필요합니다.
  • ROOT 포럼에 게시된 것과 같이 사용자의 중요한 질문에 대한 답변이 문서에 포함되어야 합니다. 이를 위해서는 가장 자주 묻는 질문을 세부적으로 분석한 다음, 새로운 '루트 매뉴얼'의 문서화 또는 참조 가이드의 새로운 튜토리얼로 번역하기 위한 통합 기간을 거쳐야 합니다.

  • 루트 7에서 제공하는 기능을 보여주는 튜토리얼입니다.

    • 새 루트 7 히스토그램
    • 새로운 루트 7 그래픽

예상 일정 (5개월):

  • 1단계: 루트 문서 및 튜토리얼의 작업 및 범위 정의: 2주
  • 2단계: 루트 포럼에서 중요한 사용자 질문 수집 및 분석: 2주
  • 3단계: 루트 문서 작성: 8주
  • 4단계: 튜토리얼 개발: 8주

마지막으로, 작년에 장기적인 Google Docs 시즌 프로젝트를 통해 ROOT 문서에 이미 기여했다는 사실을 추가해야 합니다. 매뉴얼의 구조를 새롭게 정의했습니다. 올해 제안은 ROOT에 여전히 누락된 다른 문서 작업을 완료하는 데 도움이 될 것입니다.