NFM-AD-02-0001 System Design Note Numbering Scheme

1.                   Introduction

This SDN outlines the numbering scheme to be used for NEWFIRM project SDN’s.

2.                   General Requirements

The NEWFIRM SDN identification will work within the overall project documentation structure. In this structure they fall within category AD, administrative, and subdivision 02, SDN’s. Hence the prefix structure NFM-AD-02 is fixed.

Document numbers appended to this prefix are permitted numbers 0001-9999.

2.1    Top level numerical grouping

Numbers shall be allocated by subject area as follows:

            0001+   Administrative SDN’s such as this one, and unclassifiable miscellany

            1000+   Systems engineering SDN’s dealing with two or more of the topics below

2000+   Optical SDN, including requirements, specifications, performance, testing, data compilations, detailed notes, etc.

            3000+   Mechanical SDN, including requirements, specifications, performance, data        compilations, detailed notes, etc.

            4000+   Thermal SDN, as above

            5000+   Electrical and electronics SDN, as above

            6000+   Telescope and guider SDN, treated separately since this area involves another group outside the NEWFIRM project team

            7000+   Instrument integration and test

            8000+   Detector and instrument control software

            9000+   Other software, e.g. data pipeline and data archiving software

2.2  Second level numerical grouping

Within each top level grouping, numbers shall be assigned in this way:

            0100+   Requirements (input to design)

            0200+   Specifications (output from design)

            0300+   Performance (measured results)

            0400+   Data compilations, e.g. tables of materials properties vs. temperature

            0500+   Detail notes

            0600+   Unassigned

3.  How to use this scheme

I will preassign some obvious numbers in the data base. For example, 2201, Optical design specifications.

Numbers should be preassigned logically where possible. For example, if a requirements SDN should be assigned number 3105 when it is created, then the subsequent specifications and performance SDN’s can be preassigned as 3205 and 3305 with appropriate titles. Note that preassigning a number does not necessarily mean that the SDN will be written. It is a placeholder only.

Please check with the systems engineer before assigning a number, if possible. Otherwise do your best to pick the most appropriate top level and second level prefixes and go ahead. I expect this scheme will only stay quasi-rational and there will be some arbitrariness in the numbering within a top level group.

Once a number is assigned it shall be changed only with the concurrence of the systems engineer and the project manager. I do not intend to shuffle numbers about for the sake of orderliness. There won’t be that many SDN’s.  

Home | Concept Design | Requirements | Science | Software | Management | System Design Notes | Configuration Images | Staff | Archive

rjoyce@noao.edu mjb@noao.edu