Documentation Working Group

Responsibilities

The Geant4 documentation working group is responsible for maintaining and improving the following user documents and example codes:

• Introduction to Geant4,
• Installation Guide: For setting up Geant4 in your computing environment,
• User's Guide: For Application Developers,
• User's Guide: For Toolkit Developers,
• Physics Reference Manual,
• Software Reference Manual,
• Frequently Asked Questions,
• Novice Examples.

Working Group Members and Their Responsibilities

• Katsuya Amako, KEK (coordinator)
  Responsibility: Coordinate activities of maintaining and improving all documents listed above.
• Dennis Wright, SLAC (deputy coordinator)
  Responsibility: Support the coordinator's work.
• Gabriele Cosmo, CERN
  Responsibility: Provide consultation for improvement of the global structure of documentation.
• Joseph Perl, SLAC
  Responsibility: Maintain the Installation Guide. Maintain the code and the document in the User's Guide of visualization related novice examples.
• Makoto Asai, SLAC
  Responsibility: Maintain the code and the document in the User's Guide of the novice examples 'N01', 'N04' and 'N07'.
• John Apostolakis, CERN
  Responsibility: Maintain the code and the document in the User's Guide of the novice example 'N02'.
• Michel Maire, IN2P3
  Responsibility: Maintain the code and the document in the User's Guide of the novice example 'N03'.
• Vladimir Ivanchenko, CERN
  Responsibility: Maintain the code and the document in the User's Guide of the novice example 'N03'.
• Marc Verderi, LLR/IN2P3
  Responsibility: Maintain the code and the document in the User's Guide of the novice example 'N05'.
• Peter Gumplinger, TRIUMF
  Responsibility: Maintain the code and the document in the User's Guide of the novice example 'N06'.
• John Allison, Manchester
  Responsibility: Maintain the code and the document in the User's Guide of the visualization related novice examples.

Working Plan - 2010

Make available updated users' documents in accordance with major/minor Geant4 code releases. Also irregular revisions of the documents are expected.

Working Plan - 2009

Make available updated users' documents in accordance with major/minor Geant4 code releases. Also irregular revisions of the documents are expected.

Working Plan - 2008

The transition from HTML to DocBook based documentation was successfully completed in the last year. The new scheme (i.e. the DocBook format) is already stable and the last three releases (V8.3, V9.0, V9.1) are based on it.

In this year, because of the stability of the newly developed documentation scheme, we don't have a challenging plan as we had in the last year. We are planning to release all users' documents in accordance with Geant4 code releases.

Working Plan - 2007

DocBook Project

The aim of the DocBook project is to convert the following user documents into the DocBook format:

• IntroductionToGeant4
• InstallationGuide
• ForApplicationDeveloper
• ForToolkitDeveloper

The global time schedule for this project is as follows:

• Dec. 2006:
  • Release the alpha version of the above documents in DocBook format to working group coordinators. (done)
• Jan. 2007:
  • Accept comments to the alpha version from working group coordinators (by the end of January)
• Feb. - Mar. 2007:
  • Revise the alpha version based on the feedback from the working group (by the end of March)
  • Release the beta version to all G4 working group members (by the end of March)
  • Release the web instruction of how to write G4 user doc in DocBook (by the end of March)
• Jun. 2007:
  • Release in public the 1st version at the time of 1st release of the G4 codes in 2007.