Doc Man

Document management policy, links to PmWiki instructions, and document templates go here.

Document Management Policy

Here is the policy, by order of your (mostly) benevolent dictator JSY!

• A summary of the FDR documents and their status can be found at Final Design Review Material
  • Don't attach documents to the summary page
  • See also the Official FDR Documentation List as agreed with Fernando
• Use the appropriate MRO-assigned document identifier INT-406-VEN-xxxx
• Use one of the templates below
• Use a revision number and change history (see templates)
  • Revision numbers are of the form [MAJOR].[MINOR] where [MAJOR] and [MINOR] are non-negative integers
  • Use [MAJOR] of 0 for unreleased documents and 1 for released documents. [MINOR] reverts to zero whenever [MAJOR] changes
  • Increment [MINOR] just prior to attaching a new version of the document to the wiki

MF and JSY are happy to carry out the following actions on your behalf:

• Attach each document to one wiki page only
  • Attach to the most appropriate of the pages linked from Delay Line Systems Engineering Documents
  • Make a link to the attachment from Final Design Review Material, and update the status summary as necessary
  • There is no need to rename the attachment when uploading a newer version - the wiki will automatically rename the old attachment. This way any links will automatically point to the latest version
  • If you are revising a released document, add a note to Released FDR Documents stating what was done when, such as "[Updated 2008/01/20]"
• To release a document to NMT and the reviewers, make a link to the attachment from Released FDR Documents
  • Beware that once you have released a document in this way, the link from Released FDR Documents will automatically point to any newer version that is later uploaded to the wiki (provided the instructions above about not renaming are followed)
• Announcement (2006/06/25) - brief instructions on what to use this wiki for

Document Templates

• Attach:fdr_template.zip - LaTeX template [process using latex or pdflatex (recommended)]
• Attach:oo_sw_template.zip - OpenOffice 1.x and 2.x software documentation template
• Attach:word_template.zip - MS Word template

Attachments for MROIDelayLine.DocMan

Click here to upload file to attach to this page.

• FDR_Documentation_List.pdf Δ ... 57,921 bytes ... January 14, 2008, at 05:25 PM
• fdr_template.zip Δ ... 146,033 bytes ... January 14, 2008, at 12:10 PM
• fdr_template.zip,1183655412 Δ ... 145,986 bytes ... July 03, 2007, at 04:37 PM
• fdr_template.zip,1200312649 Δ ... 146,008 bytes ... July 05, 2007, at 06:10 PM
• oo_sw_template.zip Δ ... 145,993 bytes ... January 14, 2008, at 12:11 PM
• oo_sw_template.zip,1200312698 Δ ... 145,356 bytes ... July 03, 2007, at 04:53 PM
• word_template.zip Δ ... 138,321 bytes ... January 14, 2008, at 12:11 PM
• word_template.zip,1200312719 Δ ... 95,635 bytes ... July 09, 2007, at 05:35 PM