blob: 3d24fdb6300773af875783234bb966db9b27da5e [file] [log] [blame]
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="../../../../wtp.xsl"?>
<html>
<head>
<meta name="root" content="../../../../../" />
<title>JST Web Services Design Documents</title>
</head>
<body>
<h1>Design Title</h1>
<p>
<i>(This document is a template for new design documents.
Make a copy of it, then customize all the chapters.)</i>
</p>
<h2>Credits</h2>
<table cellspacing="5" cellpadding="2" border="1">
<tr valign="top">
<td>Enhancement</td>
<td>Bugzilla # (put the main bugzilla number here, with a link)</td>
</tr>
<tr valign="top">
<td>Version</td>
<td>1.0 Draft (version number and "Draft" or "Final".</td>
</tr>
<tr valign="top">
<td>Last Updated</td>
<td>yyyy.mm.dd (keep this current)</td>
</tr>
<tr valign="top">
<td>Target Release</td>
<td>WTP 1.0 (put the WTP release here)</td>
</tr>
<tr valign="top">
<td>Target Milestone</td>
<td>M4 (put the target milestone here)</td>
</tr>
<tr valign="top">
<td>Contributors</td>
<td>
List<br/>
of<br/>
contributors
</td>
</tr>
</table>
<h2>Index</h2>
<ol>
<li><a href="#overview">Overview</a></li>
<li><a href="#requirements">Requirements</a></li>
<ol>
<li><a href="#r1">Requirement 1</a></li>
<li><a href="#r2">Requirement 2</a></li>
<ol>
<li><a href="#r2.1">Sub-requirement 2.1</a></li>
<li><a href="#r2.2">Sub-requirement 2.2</a></li>
</ol>
</ol>
<li><a href="#concepts">Conceptual Design</a></li>
<li><a href="#details">Detailed Design</a></li>
</ol>
<h2><a name="overview"/>1.0 - Overview</h2>
<p>
Write a very few paragraphs here to explain the item.
</p>
<h2><a name="requirements"/>2.0 - Requirements</h2>
<p>
Break requirements up into distinct items.
Cover aspects like standards (W3C, JCP, OASIS, etc.),
usability, performance, internationalization (I18N),
globalization (G11N), accessability, samples,
documentation, testing and test automation (JUnit).
</p>
<h3><a name="r1"/>R1 - A requirement</h3>
<p>
Write a requirement here.
</p>
<h3><a name="r2"/>R2 - A requirement</h3>
<p>
Write a requirement here.
</p>
<h3><a name="r2.1"/>R2.1 - A sub-requirement (if any)</h3>
<p>
Some requirements may break up into smaller tasty bits.
If useful, write such "sub-requirements" here.
Don't use heading-4. Just use an "x.y" number for the requirement.
</p>
<h3><a name="r2.2"/>R2.2 - A sub-requirement (if any)</h3>
<p>
...
</p>
<h2><a name="concepts"/>3.0 - Conceptual Design</h2>
<p>
Write the high-level design here. Focus on GUI and API.
</p>
<h2><a name="details"/>4.0 - Detailed Design</h2>
<p>
Write any detailed, internal design material here.
</p>
</body>
</html>