NRAO Home  >  Green Bank  |  Wiki Topic:    GB > PTCS > FormalDocumentation

Changes | Index | Search | Statistics | Go

PTCS Formal Documentation

PTCS documentation (apart from these wiki pages) falls into a number of different categories:

• External Project Review Meetings
  • InProgressReview - December 2003
  • ConceptualDesignReview - April 2003

• ProjectNotes (PN) This is the general documentation category, analogous to the GBT Memo Series. As well as more formal documentation, this category may be used to capture memos that serve as useful background, random thoughts that should be preserved, ideas that may be useful about upcoming tasks, and so forth. Any documentation that does not fall into the remaining three categories, but is still worthy of being archived, falls in this category.

• SystemNotes (SN) OBSOLETE -- DO NOT CREATE ANY MORE OF THESE PER RMP This includes documentation from the ConceptualDesignReview. Unfortunately, documentation for the InProgressReview ended up in the ProjectNotes series.

• QuarterlyReports Obsolete as of June 2005 The standard reports which we submit as part of the larger NRAO Quarterly Report.

• InternalProgressMeetings Obsolete as of September 2003 These are the presentation slides (not minutes) from the internal project progress meetings, held approximately once every six weeks (unless an external project review usurps them).

• PresentationsAndProceedings Presentations, conference proceedings, and other articles which described aspects of the PTCS project.

How to create a PTCS Project or System Note:

Project or System Notes should be created in either MS WORD or LaTeX. In either case, the output should be converted to PDF format (using Acrobat Distiller or pdflatex) as the final format for distribution.

To create a Project or System Note using MS WORD

• Take a copy of the appropriate ".dot" template (ptcspn.dot for Project Notes, ptcssn.dot for System Notes)
• Create a new blank document based on that template, and proceed from there.

ptcspn.doc (pdf version) and ptcssn.doc (pdf version) provide examples and more details.

To create a Project or System Note using LaTeX

• Take a copy of the appropriate ".sty" style file (ptcspn.sty for Project Notes, ptcssn.sty for System Notes)
• Take a copy of the example ".tex" file (ptcspn.tex for Project Notes, ptcssn.tex for System Notes)
• Save this file to an appropriate name, and proceed from there.

ptcspn.tex (pdf version) and ptcssn.tex (pdf version) provide examples and more details.

-- RichardPrestage - 05 Sep 2003