Part of the M4 exit criteria for API
definition is to have a brief overview document that "tells the story"
of the Component API. For an example, see the Server tools .
The overview can be brief. It should
not duplicate information that is in the Javadoc. Remember that each package
should have a package.html that is included with the Java source and is
linked in to the Javadoc. The component API overview should say how all
the packages are related. This might also be a good place to mention any
I suggest we adopt a simple naming and
location convention for these.
1. The name of the Component API Overview
document is: overview.html
2. The overview document is located
on the WTP Web site in the corresponding subproject component directory: