Board Documentation

My task is:

• Setup and maintain web site with board documentation
• Collect documents from people responsible for individual boards
• Bug people until documentation is complete and up to date

Minimum documentation required for each board:

• Description of the board
• This is the main document describing in detail all the features of the board including all VME registers and addresses, format of I/O data, connectors, jumpers, LED's etc.
• Schematics
• must be in .pfd or .ps format
• Layout
• must include enough information to locate any component on the board (.pdf or .ps)
• artwork of circuit layers in browser friendly format is optional
• Firmware
• readable source files: verilog, VHDL, Abel,...
• Description of VME access functions
• each function entry must be briefly described
• Description of available diagnostic software

 

 

In addition:

Each individual board designer is responsible for archiving safely all project related data that will be needed in case additional boards must be fabricated or modified. This includes CAD specific files, gerber files, firmware object files etc. These files come in so many different "standards" that I do not believe it is worth the effort of trying to collect all of them in a single place. Pointers to different sites where this information is stored may be added to the common SVT web site at each designer discretion for their own convenience.