Last Changed: Thursday, October 31, 1996 by: A. Scholand
The following page describes what is needed to fully document a new analysis module.
A software-engineering-Technical, implementation-directed description is needed. This is important for development, so that mutliple software experts (‘Integrators’) can review a) how the constraints have been implemented and b) where an analysis module is being proposed to be added to a complex O-O tree. It will also be an aid to future revisions of analysis modules.
The format for this page should be: (for a concrete example, see the PWB PM page)
This document is a very brief description of the <item name>.
<Optional Picture of Item Name>
<High level description- this serves as a repository of what the code is intended to implement (design intent)>
Documentation consists of a [constraint schematic] which graphically depicts ... and also of a Express Schema which describes...
<Picture of constraint schematic>
<Link to Example P21 file describing item>
<Link to unified APOD schema needed to compile/inpret P21 file>
Need documentation of proposed ABB and PBAM hierarchy (For example, see ABB/PBAM hierarchy page )
[End Proposed Software Specifications Page]
A mechanical-engineering-Technical description is also needed. This is important for analysis usage, so that end users can review a) what degree of accuracy is being provided and over what range of variables, b) what assumptions have been made, c) other cavaets. It will also be an aid to future revisions of analysis modules, by highlighting what the limitations of the current modules are.
The format for this page should be: (for a concrete example, see the PWB Warpage Driver Page)
<Brief discussion of why this is a problem, perhaps showing a picture indicating problem behavior>
<Brief discussion of approach of this model- simplifications, boundary conditions, limits>
<Links to References for further research and/or selection of alternate model>
<Provide math version of formulas, explanation of variables>
<explain meaning of various types of output/results>
<Links to other areas of interest- references, explanation pages on other models used here>
<Telnet helper application to launch SUI, then DAI tools>
<Eislab home, etc>
[End Proposed Engineering Technical Specifications Page]
An end-user "help me" description may be needed needed. This would include things like screen shots, typical error messages and what to when something breaks.
Many of these things are currently implemented as text files within DAI tools.