2018 Work Plan
The 2018 Work Plan is divided into four categories, with responsible members and approximate deadlines (end of calendar-year quarters) listed. As we have the new sphinx/ReST documentation format a number of items are transiational, and hopefully more people can become involved in keeping the documentation up-to-date.
- Documentation Structure
- Documentation Content
- Web Site Content
- Videos
Last updated: 27 February 2018
| Task |
Responsible |
Due |
| Periodic Release of Documents |
Alex |
Throughout 2018 |
| Look at restructuring of all documents - Introduction, FAQ, Web-based content |
Ben, Gunter, Vladimir, John, Alex |
2Q |
| Restructuring of documents - Material break between BfAD, BfTD, PRM, PLG |
Alex, Daren, Vladimir |
3Q |
| General review of documentation (especially with respect to language and completeness) |
Alex |
4Q |
|
Improve automation of Sphinx build and deployment from gitlab
|
Ben |
2Q |
| Explore cross-referencing between guides |
Ben, Alex |
1Q |
| building/installing Doxygen documentation for the examples as part of main build process (nightlies) |
Ben |
2Q |
| Task |
Responsible |
Due |
| Automatic documentation generation of Physics Lists |
Daren, Alex, Vladimir |
4Q |
| Continued Update of INCL++ documentation |
D. Mancusi |
4Q |
| Strangeness inclusion in INCL++ |
J-C David |
4Q |
| Maintenance of the geometry/persistency chapters in the manuals |
G. Cosmo |
4Q |
| building/installing Doxygen documentation for the examples as part of main build process (nightlies), |
B. Morgan |
4Q |
| Continued improvements to the documentation of hadronic physics |
A. Ribon |
4Q |
| Basic and extended Examples Documentation |
Ivana |
4Q |
| biasing documentation and FAQ |
M. Verderi |
4Q |
| support documentation for EM physics |
V. Ivantchenko |
4Q |
| Maintain and update documentation for hadronic models â low energy neutrons, G4ENDL, particle_hp, QMD |
TBD |
4Q |
| Provide close review of release notes, installation guides and our overall face that we show to our less expert users with eye towards helping these users understand how to get up and running and stay up and running |
TBD |
4Q |
| Reach consensus on format for automatic documentation of EM physics lists and update code accordingly |
Daren |
3Q |
| Expand documentation on channelling physics process ("exotic physics") |
Enrico |
4Q |
| Task |
Responsible |
Due |
| Investigate migration of Web site to modern content management system, such as Drupal at CERN. Includes investigating capability to provide protected/internal Web areas and public/unprotected areas, along with continued Web access to tags database. |
G. Folger, A. Howard |
2Q |
| (Steering Board Action Item 75.10) Expand Web pages of publications, validation results, and external citations, per suggestion from 2012 external review. |
TBD, Wright |
Ongoing |
| (Steering Board Action Item 75.10) "Better Web "advertising" of GEANT4 achievements" |
Makoto, Alex, Ben, Gunter, Laurent |
Ongoing |
| (Steering Board Action Item 75.9) "Consult with the responsible parties for different documentation/common Web page areas to develop a consistent interface" |
Makoto, Alex |
Ongoing |
| web presence: host the generated Doxygen on the website |
B. Morgan |
4Q |
| vis documentation |
J. Allison |
4Q |
| consider our web-presence |
Makoto, A. Howard |
4Q |
| Task |
Responsible |
Due |
| G4 Videos |
L. Garnier |
4Q |
| Investigate central repository for video information - demonstrations, tutorials, publicity. Consider creating our own youtube, vimeo, whatever page. Linked into Drupal Migration. |
Laurent, Marc, Alex, Gunter |
2Q |