CERN-HSF project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- CERN-HSF
- Technical writer:
- LuckInTheRain
- Project name:
- Extending and improving the ROOT documentation
- Project length:
- Long running (5 months)
Project description
The project has the goal of improving the documentation of ROOT, which is the main software system for data analysis and data presentation used by the high-energy physics community world-wide.
Besides the technical writer skills that I can provide for the project, I am also familiar with ROOT (6 & 7) and I have knowledge of other components required by the project, such as:
- C++
- Python
- Git/GitHub
- Web site construction tools (html, markdown, Jekyll)
I identify three main pieces in the ROOT documentation:
- the web site https://root.cern,
- the C++ class reference guide https://root.cern/doc/master/,
- the forum https://root-forum.cern.ch
Seems to me the ROOT documentation (the new "ROOT manual") need to be improved and supplemented in the following areas:
- It should become more accessible and understandable for non-physicists in particular the introductory chapters.
- More tutorials explaining the general functionality of ROOT shall be developed.
- Some new topics and developments shall be included with detailed descriptions and examples.
Among those I can list:
- The Python binding
- The mathematical libraries
- Manual description for high level graphics tools (TRatioPLot, THStack)
- The new data mining analysis tools (RDataFrame and RNtuple)
- The new key data formats (RDataFrame and RNtuple) need detailed technical specifications and tutorials.
Answers to important questions from users, such as those posted in the ROOT forum, will need be included in the documentation. This requires a fine analysis of the most often asked questions followed by a synthesis period to translate them into pieces of documentation in the new "ROOT Manual" or in new some tutorials in the Reference Guide.
Tutorials illustrating the functionalities provided by ROOT 7.
- New ROOT 7 histograms
- New ROOT 7 graphics
Estimated time schedule (5 months):
- Phase 1: Definition of tasks and scope for ROOT documentation and tutorials: 2 weeks.
- Phase 2: Gather and analyse important users' questions from the ROOT forum: 2 weeks
- Phase 3: Writing ROOT documentation: 8 weeks.
- Phase 4: Developing tutorials: 8 weeks
Finally I should add that I have already contributed to the ROOT documentation last year with a long-term Google Season of Docs project. I defined the new structure of the Manual.
The proposal this year will contribute to the completion of other documentation aspects still missing in ROOT.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThis project aims to improve and extend the documentation of ROOT, a data analysis software used by the high-energy physics community.\u003c/p\u003e\n"],["\u003cp\u003eThe focus is on making the documentation more accessible to non-physicists, adding tutorials on core functionalities and new features like Python bindings and data mining tools.\u003c/p\u003e\n"],["\u003cp\u003eKey deliverables include technical specifications, tutorials on RDataFrame and RNtuple, and incorporating answers to frequently asked user questions.\u003c/p\u003e\n"],["\u003cp\u003eThe project will be executed in phases, starting with defining the scope, analyzing user questions, writing documentation, and developing tutorials.\u003c/p\u003e\n"],["\u003cp\u003eThe contributor has prior experience with ROOT and previously contributed to its documentation through Google Season of Docs.\u003c/p\u003e\n"]]],["The project aims to enhance the ROOT documentation, a crucial tool for high-energy physics. Key actions include improving accessibility for non-physicists, developing new tutorials on general ROOT functionality, and documenting new features like Python bindings and data mining tools (RDataFrame, RNtuple). The project will also synthesize frequently asked questions from the ROOT forum into the documentation. A five-month timeline involves defining the documentation's scope, analyzing user questions, writing the documentation, and creating tutorials.\n"],null,["# CERN-HSF project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: CERN-HSF\n\nTechnical writer:\n: LuckInTheRain\n\nProject name:\n: Extending and improving the ROOT documentation\n\nProject length:\n: Long running (5 months)\n\n### Project description\n\nThe project has the goal of improving the documentation of ROOT, which is the main software system for data analysis and data presentation used by the high-energy physics community world-wide.\n\nBesides the technical writer skills that I can provide for the project, I am also familiar with ROOT (6 \\& 7) and I have knowledge of other components required by the project, such as:\n\n- C++\n- Python\n- Git/GitHub\n- Web site construction tools (html, markdown, Jekyll)\n\nI identify three main pieces in the ROOT documentation:\n\n- the web site https://root.cern,\n- the C++ class reference guide https://root.cern/doc/master/,\n- the forum https://root-forum.cern.ch\n\nSeems to me the ROOT documentation (the new \"ROOT manual\") need to be improved and supplemented in the following areas:\n\n- It should become more accessible and understandable for non-physicists in particular the introductory chapters.\n- More tutorials explaining the general functionality of ROOT shall be developed.\n- Some new topics and developments shall be included with detailed descriptions and examples. Among those I can list:\n - The Python binding\n - The mathematical libraries\n - Manual description for high level graphics tools (TRatioPLot, THStack)\n - The new data mining analysis tools (RDataFrame and RNtuple)\n- The new key data formats (RDataFrame and RNtuple) need detailed technical specifications and tutorials.\n- Answers to important questions from users, such as those posted in the ROOT forum, will need be included in the documentation. This requires a fine analysis of the most often asked questions followed by a synthesis period to translate them into pieces of documentation in the new \"ROOT Manual\" or in new some tutorials in the Reference Guide.\n\n- Tutorials illustrating the functionalities provided by ROOT 7.\n\n - New ROOT 7 histograms\n - New ROOT 7 graphics\n\nEstimated time schedule (5 months):\n\n- Phase 1: Definition of tasks and scope for ROOT documentation and tutorials: 2 weeks.\n- Phase 2: Gather and analyse important users' questions from the ROOT forum: 2 weeks\n- Phase 3: Writing ROOT documentation: 8 weeks.\n- Phase 4: Developing tutorials: 8 weeks\n\nFinally I should add that I have already contributed to the ROOT documentation last year with a long-term Google Season of Docs project. I defined the new structure of the Manual.\nThe proposal this year will contribute to the completion of other documentation aspects still missing in ROOT."]]
