이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- CERN-HSF
- 테크니컬 라이터:
- 존
- 프로젝트 이름:
- CERN-HSF - '모든 연령대' 채택, 동적 Python 바인딩, 튜토리얼을 위한 ROOT 문서
- 프로젝트 기간:
- 장기 실행 (5개월)
Project description
CERN-HSF - 모든 연령대를 위한 ROOT 문서, 동적 Python 바인딩 및 튜토리얼 멘토: 올리비에 쿠에, 악셀 나우만
개요: 문서는 사용자가 소프트웨어를 성공적이고 효율적으로 채택하는 데 필수적입니다. 명확하고 정확하며 포괄적인 사용자 문서는 사용자가 목표를 달성하기 위해 노력하는 과정에서 소프트웨어를 능숙하게 사용할 수 있도록 지원합니다. 이와 함께 명시적인 예와 튜토리얼도 사용자가 빠르게 배울 수 있는 강력한 도구의 역할을 합니다.
물리학자, 연구원, 개발자가 물리학을 위한 데이터 분석 및 시각화 공간에서 ROOT를 사용하는 방식을 살펴보면 사용자 친화적이고 업데이트된 문서의 이점을 인식하게 되었습니다. 특히 소스 코드의 방대함과 그 성장으로 인해 문서 시스템은 사용자에게 루트가 제공하는 모든 기능을 극대화할 수 있도록 병렬 방식으로 진화하는 이점을 누릴 수 있습니다.
최신 문서의 요약 및 분석 현재 사용자 문서에서는 일반 사용자보다 물리학자들이 더 쉽게 루트를 채택할 수 있도록 가이드를 제공합니다. 또한 동적 Python 바인딩과 같은 특정 주제 내에서 더 포괄적이고 명확한 문서를 개선할 수 있습니다. 마찬가지로 새 데이터 형식 RNTuple에는 필요한 세부 사양이 없습니다. 마지막으로 현재 문서에는 루트 7과 관련된 튜토리얼이 없습니다.
방법론: Olivier와 논의한 결과 앞서 언급한 문제를 해결하기 위해서는 전문 연구자와 일반 대상 간의 지식 격차를 파악하고, 이러한 차이를 해소할 수 있는 문서 작성, 동적 Python 바인딩에 대한 보다 자세한 문서 작성, ROOT 7에 대한 '현대 분석 튜토리얼' 구현, RNTuple에 대한 상세 기술 사양 작성이 주된 초점이 될 것으로 판단되었습니다. 이와 더불어 이 프로세스 중에 문서에 Jupyter 노트북을 통합할 수 있으므로 실질적이고 대화형 학습 도구가 사용자에게 도움이 될 수 있습니다.
타임라인: 프로젝트 단계는 다음과 같을 것으로 예상됩니다. 전문 연구원과 일반 대상 간의 지식 격차 파악 (최신 문서 및 소스 코드를 읽으면서) → 1~2주 간격을 메우기 위한 문서 작성 및 리팩터링: 3주. 동적 Python 바인딩 세부 문서 작성 → 3주 NT 바인딩 튜토리얼 구현 3주 → 3주 3주 완료 → 3주 동안 프로젝트 사양 구현 ROOT 7 단계 완료 → 최신 문서 및 소스 코드 읽기
성공을 위한 결과물 및 가이드라인: 격차 없는 단일 통합 사용자 문서 최신 기능(예: 새로운 파생 클래스)을 반영하도록 사용자 문서가 완전히 업데이트됨 Jupyter 노트북을 통한 가이드