Documentation Task Force
Introduction

Charge

Schedule

Meetings

Code Reviews
TkrRecon 
G4Generator 
Cal 
FluxSvc
TkrRecon II
ACD 
Gaudi
L1 Dbs et. al.
RootCnvSvc

Preliminary Recommendations
Code Recommendations

Editing:
Code:  doc   rtf

Web:   doc   rtf
Guides:  doc   rtf

Code Templates

Web Page Templates

User Guides
Gleam User Guide 
Schedule

Cookbook

Membership


Introduction

Dedicated to the safety and well being of GLAST Science Analysis Software (SAS) documentation.

Charge

This group is charged with creating, implementing, and maintaining a GLAST software documentation plan.  In particular this group should:

  1. Ensure that all GLAST SAS policies and procedures are accurately documented.
  2. Provide and maintain standard templates for:
    1. GLAST SAS source and header files
    2. GLAST SAS web pages
  3. Assess the current documentation both for developers and users.
    1. Audit all GLAST SAS web pages to insure consistency and readability.
    2. Audit existing Doxygen generated developer documentation to highlight areas of improvement and guide creation of Doxygen guidelines.
    3. Reorganize existing documentation, in conjunction with documentation owners, as necessary.
  4. Maintain Doxygen guidelines for GLAST SAS, including examples.
  5. Maintain automated generation of Doxygen pages for code packages, where the documentation is then web accessible.
  6. Develop plans for generating and maintaining a GLAST SAS Developers' Guide.
  7. Develop plans for generating and maintaining a GLAST SAS Users' Guide.
  8. Arrange and participate in developer and user documentation walk-throughs.
  9. Develop and provide online tutorials and cookbooks for all key GLAST SAS utilities and products.
  10. Develop a plan for regular maintenance of the documentation.

Preliminary Schedule

Item (2) Standard templates will be completed the end of December 2001.

Item (3a) The audit of existing web pages should be completed by mid January 2002.  (3c) The web pages will be reorganized by mid February 2002.

Item (3b) The audit of existing Doxygen pages will be completed by mid-January 2002.  Suggestions will be provided to package owners by mid-February 2002.

Item (4) Guidelines and documentation for Doxygen usage will be completed by early January 2002.

Item (5) The automated generation of Doxygen pages is ongoing, and the initial scripts are in place.

Item (6) The outline and design report of the first GLAST SAS Developer's Guide will be created by March 2002.  A first draft of the Developer's Guide will be available for review by July 2002.

Item (7) The outline and design report of the first GLAST SAS User's Guide will be created by August 2002.  A first draft of the User's Guide will be available for review by October 2002.

Item (8) The methods and procedures for conducting documentation walk-throughs will be drawn up by the end of February 2002.  The first of these walk-throughs will be scheduled for late March 2002, as the new version of the reconstruction algorithms become available.

Item (9) A design report and list of required tutorials will be generated by March 2002.  The first online tutorial will be made available July 2002.

Membership

Joanne Bogart
Traudl Hansl-Kozanecka
Heather Kelly (chair)
Bob Schaefer
Alex Schlessinger
Gloria Spandre
Mark Strickman
Karl Young

Back to GLAST Software Home

H. Kelly Last Modified:  2004-08-04 15:57:31 -0700