• • ServoReplacementDesignReview - January 2009

• SystemNotes (SN) OBSOLETE -- DO NOT CREATE ANY MORE OF THESE PER RMP

• SystemNotes (SN) __OBSOLETE -- DO NOT CREATE ANY MORE OF THESE

• QuarterlyReports Obsolete as of June 2005

• QuarterlyReports

• SystemNotes (SN)

• SystemNotes (SN) OBSOLETE -- DO NOT CREATE ANY MORE OF THESE PER RMP

Substantive, non-ephemeral project documentation that should be archived. This includes documentation from the ConceptualDesignReview and in the future will include documentation from the In-Progress Reviews.

This includes documentation from the ConceptualDesignReview. Unfortunately, documentation for the InProgressReview ended up in the ProjectNotes series.

• QuarterlyReports

• QuarterlyReports Obsolete as of June 2005

• InternalProgressMeetings

• InternalProgressMeetings Obsolete as of September 2003

• ProgramPlan? PTCS contributions to the GBT section of the Program Plan

• VistingCommitteeReports? PTCS contributions to the GBT Visiting and Users Committee Reports

• ProgramPlan? PTCS contributions to the GBT section of the Program Plan

• VistingCommitteeReports? PTCS contributions to the GBT Visiting and Users Committee Reports

• External Project Review Meetings

• External Project Review Meetings
  • InProgressReview - December 2003

PTCS documentation falls into one of five different classes:

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

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

• External Project Review Meetings
  • ConceptualDesignReview - April 2003

• ProjectNotes (PN)

• SystemNotes (SN)

• QuarterlyReports

• InternalProgressMeetings 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).

PTCS documentation falls into one of four different classes:

PTCS documentation falls into one of five different classes:

that should be archived. This might include documentation from review sessions (CoDR, CDR, PDR).

that should be archived. This includes documentation from the ConceptualDesignReview and in the future will include documentation from the In-Progress Reviews.

%META:TOPICINFO{author="RichardPrestage" date="1062805560" format="1.0" version="1.1"}% %META:TOPICPARENT{name="WebHome"}%

PTCS Formal Documentation

PTCS documentation falls into one of four different classes:

• 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) Substantive, non-ephemeral project documentation that should be archived. This might include documentation from review sessions (CoDR, CDR, PDR).
• Project Artifacts (PA). This includes: Project Charters; design documents that encompass a portion of, but not the whole project (for example, software or electronics design documentation that may be used internal to those divisions).
• Modification Requests (MR). These are lightweight (1-3 page) summaries of a task to be accomplished, the approach to completing that task, appropriate design summary or design constraints, and test details to ensure that what is delivered meets expectations. These are currently only used for the software division.

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