PBAM Web Documentation Guidelines

Version 0.001

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)

<Item Name>

Specifications Sheet


1. Overview


2. Documentation


3. Hierarchical relationships

[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)

<Design Problem Needing Analysis>

A Design and Analysis Problem


1. Introduction

2. PBAM Tool to Analyze this Problem

3. Where Do I go From Here?

[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.