[opengtoolkit-cvs] deab/Software Project Multi-Map/ReadySET-0-9-1/docs HOWTO-upgrade.html,NONE,1.1 f

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/opengtoolkit/deab/Software Project Multi-Map/ReadySET-0-9-1/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31503/Software Project Multi-Map/ReadySET-0-9-1/docs

Added Files:
	HOWTO-upgrade.html faq.html recommended-tools.html 
	release-notes-0-9-0.html release-notes-0-9-1.html 
Log Message:
initial commit

--- NEW FILE: release-notes-0-9-1.html ---
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//Tigris//DTD XHTML 1.0 Transitional//EN"
"http://style.tigris.org/tigris_transitional.dtd">
<html>
<head>
 <style type="text/css">
/* <![CDATA[ */ 
@import "../templates/css/readyset.css"; 
@import "../templates/css/inst.css"; 
/*  ]]> */
 </style>

 <title>Release Notes</title>
</head>

<body>
 <h2>ReadySET 0.9.1: Release Notes</h2>

<div class="app">
<div class="readyset">

 <div id="releaseinfo">
 <h3>Product Release Information</h3>
 <table border="1" cellpadding="3" cellspacing="2" class="axial">
  <tr>
   <th>Product:</th> 
   <td><a href="http://readyset.tigris.org/">ReadySET</a></td> 
  </tr>
  <tr>
   <th>Release Number:</th> 
   <td>
     0.9.1
   </td> 
  </tr>
  <tr>
   <th>Release Date:</th> 
   <td>
     2004/07/08
   </td>
  </tr>
  <tr>
   <th>Customer Support:</th> 
   <td>For more information or support, please visit our 
      <a href="http://readyset.tigris.org/">website</a>
       or email us at
       <a href="mailto:dev&#064;readyset.tigris.org">dev&#064;readyset.tigris.org</a>
   </td> 
  </tr>
 </table>
 </div> <!-- /releaseinfo -->

 <div id="introduction">
 <h3>Introduction</h3>

This document contains the release notes for ReadySET version
 0.9.1. The following sections describe the release in detail and
 provide late-breaking or other information that supplements the
 main documentation.

This is an early access release for wide evaluation and usage.
 Your feedback is important to us, please help us make this the best
 product possible. Keep in mind that we are continuing to work on
 this product and things may change in the future.

 </div> <!-- /introduction -->

 <div id="whatsnew">
 <h3>What's New?</h3>

 <ul>
  <li>New content in interviews, persistence design, and security checklist</li>

  <li>Clarified the relationship between feature specs and use cases</li>

  <li>Clarified the relationship between internal and external release
  numbers</li>

  <li>Refactored the interview checklists</li>

  <li>Images now display properly in IE</li>

  <li>Clicking on a link with an anchor now highlights the target
  element for users of Mozilla and Firefox.</li>

<li>Many small quality improvements. See "Recent Changes" below for
 details.</li>

 </ul>

 </div> <!-- /whatsnew -->

 <div id="installation">
 <h3>Installation and Upgrade Notes</h3>

 <dl>

 <dt>Installation</dt>

 <dd>ReadySET is not a program, it is just a set of XHTML templates, so
 no installation is needed.</dd>

 <dd>Just unzip the archive, copy into your project website or version
 control system, and edit the templates to describe your project.</dd>

 <dt>Manifest</dt>

 <dd>This release consists of the following items:
 <ul>
  <li>XHTML templates and CSS stylesheets</li>
  <li>FAQ, HOWTO-upgrade, recommended tools, and release notes (this file)</li>
 </ul>
 </dd>

 <dt>Minimum System Requirements</dt>

 <dd>You can use ReadySET on any computer that can run a text editor
 and a web browser.</dd>

 <dd>It is recommended that you use a text editor to edit the
 templates, however you may try other <a
 href="http://readyset.tigris.org/docs/recommended-tools.html">recommended
 tools</a> for XHTML editing.</dd>

 <dt>Version Compatibility</dt>

 <dd>If you've been using an earlier version of ReadySET, see the <a
 href="http://readyset.tigris.org/docs/HOWTO-upgrade.html">upgrade
 HOWTO</a>.</dd>

 </dl>

 </div> <!-- /installation -->

 <div id="recentchanges">
 <h3>Recent Changes</h3>

<table>
 <tr class="a"><th>ID</th><th>Type</th><th>Summary</th></tr>
 <tr class="a"><td>42</td><td>ENHANCEMENT</td><td>automate prackaging procedure</td></tr>
 <tr class="a"><td>47</td><td>ENHANCEMENT</td><td>move interview checklist out of interview-notes.html</td></tr>
 <tr class="a"><td>48</td><td>ENHANCEMENT</td><td>new questions in interviews</td></tr>
 <tr class="a"><td>50</td><td>ENHANCEMENT</td><td>clarify component.html "available interfaces"</td></tr>
 <tr class="a"><td>51</td><td>ENHANCEMENT</td><td>prompt for file format</td></tr>
 <tr class="a"><td>53</td><td>ENHANCEMENT</td><td>clarify feature vs. use case</td></tr>
 <tr class="a"><td>55</td><td>DEFECT</td><td>transparent images not working in IE</td></tr>
 <tr class="a"><td>56</td><td>DEFECT</td><td>clarify internal and external release numbers</td></tr>
 <tr class="a"><td>57</td><td>DEFECT</td><td>make it easier to see anchors</td></tr>
 <tr class="a"><td>58</td><td>DEFECT</td><td>use help cursor for links to term definitions </td></tr>
 </table>

 </div> <!-- /recentchanges -->

 <div id="knownproblems">
 <h3>Known Problems and Workarounds</h3>

 <p>There are no known problems in this release.</p>

 </div> <!-- /knownproblems -->

</div>
</div>
</body>
</html>

--- NEW FILE: release-notes-0-9-0.html ---
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//Tigris//DTD XHTML 1.0 Transitional//EN"
"http://style.tigris.org/tigris_transitional.dtd">
<html>
<head>
 <style type="text/css">
/* <![CDATA[ */ 
@import "../templates/css/readyset.css"; 
@import "../templates/css/inst.css"; 
/*  ]]> */
 </style>

 <title>Release Notes</title>
</head>

<body>
 <h2>ReadySET 0.9.0: Release Notes</h2>

<div class="app">
<div class="readyset">

 <div id="releaseinfo">
 <h3>Product Release Information</h3>
 <table border="1" cellpadding="3" cellspacing="2" class="axial">
  <tr>
   <th>Product:</th> 
   <td><a href="http://readyset.tigris.org/">ReadySET</a></td> 
  </tr>
  <tr>
   <th>Release Number:</th> 
   <td>
     0.9.0
   </td> 
  </tr>
  <tr>
   <th>Release Date:</th> 
   <td>
     2004/03/02
   </td> 
  </tr>
  <tr>
   <th>Customer Support:</th> 
   <td>For more information or support, please visit our 
      <a href="http://readyset.tigris.org/">website</a>
       or email us at
       <a href="mailto:dev&#064;readyset.tigris.org">dev&#064;readyset.tigris.org</a>
   </td> 
  </tr>
 </table>
 </div> <!-- /releaseinfo -->

 <div id="introduction">
 <h3>Introduction</h3>

This document contains the release notes for ReadySET version
 0.9.0. The following sections describe the release in detail and
 provide late-breaking or other information that supplements the
 main documentation.

This is an early access release for wide evaluation and usage.
 Your feedback is important to us, please help us make this the best
 product possible. Keep in mind that we are continuing to work on
 this product and things may change in the future.

 </div> <!-- /introduction -->

 <div id="whatsnew">
 <h3>What's New?</h3>

 <ul>
  <li>Added templates to help visualize and record test runs</li>

  <li>Enhanced glossary with data dictionary examples and technical
  terms related to software quality</li>

  <li>Enhanced and refactored checklists and words-of-wisdom</li>

  <li>More consistent cross-links and page headers</li>

  <li>Improved and simplified XHTML markup</li>

<li>Many small quality improvements. See "Recent Changes" below for
 details.</li>

 </ul>

 </div> <!-- /whatsnew -->

 <div id="installation">
 <h3>Installation and Upgrade Notes</h3>

 <dl>

 <dt>Installation</dt>

 <dd>ReadySET is not a program, it is just a set of XHTML templates, so
 no installation is needed.</dd>

 <dd>Just unzip the archive, copy into your project website or version
 control system, and edit the templates to describe your project.</dd>

 <dt>Manifest</dt>

 <dd>This release consists of the following items:
 <ul>
  <li>XHTML templates and CSS stylesheets</li>
  <li>FAQ, HOWTO-upgrade</li>
  <li>Release notes (this file)</li>
 </ul>
 </dd>

 <dt>Minimum System Requirements</dt>

 <dd>You can use ReadySET on any computer that can run a text editor
 and a web browser.</dd>

 <dd>It is recommended that you use a text editor to edit the
 templates, however you may try other <a
 href="http://readyset.tigris.org/docs/recommended-tools.html">recommended
 tools</a> for XHTML editing.</dd>

 <dt>Version Compatibility</dt>

 <dd>If you've been using an earlier version of ReadySET, see the <a
 href="http://readyset.tigris.org/docs/HOWTO-upgrade.html">upgrade
 HOWTO</a>.</dd>

 </dl>

 </div> <!-- /installation -->

 <div id="recentchanges">
 <h3>Recent Changes</h3>

 <table>
  <tr class="a"><th>ID</th><th>Type</th><th>Summary</th></tr>
  <tr class="a"><td>01</td><td>FEATURE</td><td>integrate test run report</td></tr>
  <tr class="a"><td>22</td><td>DEFECT</td><td>data dictionary examples</td></tr>
  <tr class="a"><td>28</td><td>Enhanced</td><td>checklist item: has this been communicated?</td></tr>
  <tr class="a"><td>30</td><td>TASK</td><td>add release notes</td></tr>
  <tr class="a"><td>31</td><td>FEATURE</td><td>HOW-TO upgrade ReadySET</td></tr>
  <tr class="a"><td>34</td><td>ENHANCEMENT</td><td>divs w/ id's</td></tr>
  <tr class="a"><td>36</td><td>DEFECT</td><td>more compact project overview</td></tr>
  <tr class="a"><td>37</td><td>DEFECT</td><td>need better defect terms</td></tr>
  <tr class="a"><td>38</td><td>TASK</td><td>update copyright to 2004</td></tr>
  <tr class="a"><td>39</td><td>DEFECT</td><td>clarify alternatives in multiple choice</td></tr>
  <tr class="a"><td>40</td><td>ENHANCEMENT</td><td>make the header links more consistent</td></tr>
  <tr class="a"><td>43</td><td>ENHANCEMENT</td><td>use linklist to simplify markup</td></tr>
  <tr class="a"><td>44</td><td>DEFECT</td><td>release-notes markup is inconsistent</td></tr>
 </table>

 </div> <!-- /recentchanges -->

 <div id="knownproblems">
 <h3>Known Problems and Workarounds</h3>

 <p>There are no known problems in this release.</p>

 </div> <!-- /knownproblems -->

</div>
</div>
</body>
</html>

--- NEW FILE: recommended-tools.html ---
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//Tigris//DTD XHTML 1.0 Transitional//EN"
"http://style.tigris.org/tigris_transitional.dtd">
<html>
<head>
 <style type="text/css">
/* <![CDATA[ */ 
@import "../templates/css/readyset.css"; 
@import "../templates/css/inst.css"; 
/*  ]]> */
 </style>

</script>
 <title>Recommended Tools</title>
</head>

<body>
<div class="app">
<div class="readyset">
 <h2>ReadySET: Recommended Tools</h2>

 <h3>Any Operating System</h3>

 <dl>
  <dt>Text Editors</dt>

  <dd>
   <ul>
    <li><a href="http://www.netbeans.org/">Netbeans</a></li>
    <li><a href="http://www.eclipse.org/">Eclipse</a></li>
    <li><a href="http://www.xemacs.org/">xemacs</a></li>
   </ul>
  </dd>

  <dt>HTML Editors</dt>

  <dd>
   <ul>
    <li><a href="http://www.mozilla.org/">Mozilla Editor</a>: Easy to
    use.  Spellcheck module available from mozdev.org.</li>
   </ul>
  </dd>

  <dt>Utilities</dt>

  <dd>
   <ul>
    <li><a href="http://tidy.sourceforge.net/">Tidy</a>: detects errors in HTML.</li>
    <li><a href="http://validator.w3.org/">W3 XHTML validator</a></li>
   </ul>
  </dd>

 </dl>

 <h3>Windows Operating System</h3>

 <dl>
  <dt>Text Editors</dt>

  <dd>
   <ul>

    <li>Notepad: already installed on every machine, but lacks HTML
    support and spell check.</li>

    <li><a href="http://www.textpad.com/">Textpad</a>: Simple text
    editor.  Includes HTML support and spellcheck.</li>

   </ul>
  </dd>

  <dt>HTML Editors</dt>

  <dd>
   <ul>
    <li><a href="http://www.mozilla.org/">Mozilla Editor</a>: Easy to
    use.  Spellcheck module available from mozdev.org.</li>
   </ul>
  </dd>

  <dt>XML Editors</dt>

  <dd>
   <ul>
    <li>TBD</li>
   </ul>
  </dd>
 </dl>

 <h3>Linux Operating System</h3>

 <dl>
  <dt>Text Editors</dt>

  <dd>
   <ul>
    <li>Emacs, vi, etc.</li>
   </ul>
  </dd>

  <dt>HTML Editors</dt>

  <dd>
   <ul>
    <li><a href="http://quanta.sourceforge.net/">Quanta Plus</a> </li>
   </ul>
  </dd>

  <dt>XML Editors</dt>

  <dd>
   <ul>
    <li>TBD</li>
   </ul>
  </dd>

 </dl>

 <h3>Further Reading and Resources</h3>

 <dl>
  <dt>Books</dt>

  <dd>
   <ul>
    <li><a href="http://jrobbins.org/books/">Books on HTML and CSS</a></li>
   </ul>
  </dd>

  <dt>Websites</dt>

  <dd>
   <ul>
    <li><a href="http://www.w3.org/MarkUp/Guide/">Getting started with HTML</a>: a gentle introduction</li>
    <li><a href="http://w3.org/">W3C standards organization</a> </li>
    <li><a href="http://w3schools.com/">w3schools.com</a>: Very fast and to-the-point tutorials on web technologies</li>
    <li><a href="http://htmlhelp.com/">htmlhelp.com</a>: good all-around site for HTML and related info </li>
    <li><a href="http://directory.google.com/Top/Computers/Data_Formats/Markup_Languages/">OpenDirectory page on markup langugages</a>: Including XHTML and tools</li>
   </ul>
  </dd>

 </dl>

</div>
</div>

</body>
</html>

--- NEW FILE: HOWTO-upgrade.html ---
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//Tigris//DTD XHTML 1.0 Transitional//EN"
"http://style.tigris.org/tigris_transitional.dtd">
<html>
<head>
 <style type="text/css">
/* <![CDATA[ */ 
@import "../templates/css/readyset.css"; 
@import "../templates/css/inst.css"; 
/*  ]]> */
 </style>

</script>
 <title>How to Upgrade</title>
</head>

<body>
<div class="app">
<div class="readyset">
 <h2>ReadySET: How to upgrade</h2>

 <h3>Disclaimer</h3>

ReadySET is still in fairly early releases that are rapidly
 evolving. The differences between any two early releases may be
 quite large, making upgrading difficult.

 <p>As ReadySET matures (i.e., passes v1.0.0), the changes between
 minor versions should become smaller and easier to upgrade.</p>

 <p>Also, some of the ReadySET content that is most likely to change
 and grow over time is not part of the templates at all, it is the <a
 href="http://readyset.tigris.org/words-of-wisdom/">words of
 wisdom</a> hosted on the ReadySET web site.</p>

 <h3>Low-Tech Upgrade Proceedure</h3>

 <p>You may simply cut and paste sections of HTML source code between
 new ReadySET templates and files that you have been using in your
 project.</p>

While potentially tedious and somewhat error-prone, this method
 requires no training or specific tools. It also has the advantages
 that it is very easy to update only as many or as few files as you
 desire.

 <p>Check the release-notes.html in the new release of ReadySET for a
 summary of changes.</p>

 <h3>High-Tech Upgrade Proceedure</h3>

 <p>For users that use CVS for their own project: you can use CVS's <a
 href="http://cvsbook.red-bean.com/cvsbook.html#Tracking_Third-Party_Sources__Vendor_Branches_">vendor
 branch</a> feature to help you merge the latest changes from the
 ReadySET project into your project.</p>

Let's assume that you are upgrading from ReadySET v0.8.2 to
 v0.9.1. Let's also assume that you consider "Tigris.org" to be the
 vendor of ReadySET. Note that CVS does not allow periods in tag
 names, and we do not want ReadySET version numbers to conflict with
 any version numbers of your projects, so we will make the names more
 distinctive and use underscores instead: ReadySET_0_8_2,
 ReadySET_0_9_1, Tigris_org.

 <p>Let's further assume that you are using a CVS server located at
 cvs.yourcompany.com with a repository located at /cvs, your username
 is username, and that you are using ReadySET for a project named
 yourproject.</p>

 <p>Steps:</p>

 <ol>

  <li>Unpack ReadySET v0.8.2 and add it to <strong>your</strong> CVS
    repository on a vendor branch.
  <pre>
  unzip ReadySET-082.zip
  cd ReadySET-082/templates
  cvs -d :pserver:use...@cv...:/cvs import -m 'importing ReadySET v0.8.2' yourproject Tigris_org ReadySET_0_8_2
  cd ..
  </pre>
  </li>

  <li>Unpack ReadySET v0.9.1 and add it to <strong>your</strong> CVS
    repository on the same vendor branch.
  <pre>
  unzip ReadySET-091.zip
  cd ReadySET-091/templates
  cvs -d :pserver:use...@cv...:/cvs import -m 'importing ReadySET v0.9.1' yourproject Tigris_org ReadySET_0_9_1
  cd ..
  </pre>
  </li>

<li>Create a working copy of your project documents (if you don't
 already have one).
 <pre>
 mkdir workingcopy
 cd workingcopy
 cvs -d :pserver:use...@cv...:/cvs co yourproject
 </pre>
 </li>

<li>Merge the differences between the two vendor
 versions of ReadySET into your working copy.
 <pre>
 cd yourproject
 cvs update -j ReadySET_0_8_2 -j ReadySET_0_9_1
 </pre>
 </li>

<li>You are likely to see several messages from CVS about merging
 files and conflicts. The CVS output lines that begin with "C"
 indicate conflicts.</li>

<li>Edit your working copy files to resolve all conflicts. Browse
 the files to make sure that they look OK. If any files have changed
 names, you will have to cut and paste content from the old filename
 to the new filename.</li>

  <li>Commit your updated files to your repository
  <pre>
   cvs commit -m 'updated project documents to use newer ReadySET templates'
  </pre>
  </li>

 </ol>

 <p>These steps are specific to CVS, but other version control systems
 likely provide analogous functionality.</p>

</div>
</div>

</body>
</html>

--- NEW FILE: faq.html ---
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//Tigris//DTD XHTML 1.0 Transitional//EN"
"http://style.tigris.org/tigris_transitional.dtd">
<html>
<head>
 <style type="text/css">
/* <![CDATA[ */ 
@import "../templates/css/readyset.css"; 
@import "../templates/css/inst.css"; 
/*  ]]> */
 </style>

</script>
 <title>User FAQ</title>
</head>

<body>
<div class="app">
<div class="readyset">
 <h2>ReadySET: User FAQ</h2>

 <h3>General Information</h3>

 <dl>
  <dt>What is ReadySET?</dt>

<dd>It is a set of ready-to-use software engineering templates.
 Please, see the <a href="http://readyset.tigris.org/">ReadySET homepage</a>.</dd>

  <dt>Where does the name "ReadySET" come from?</dt>

<dd>"ReadySET" is short for "Ready-to-use Software Engineering
 Templates". It also sounds like the phrase "ready, set, go!" which
 is said at the beginning of a race to give everyone a fair start.
 </dd>

  <dt>Where did the ideas for ReadySET templates come from?</dt>

<dd>The general idea came from a need for me to provide a lot of
 guidance to university students learning software engineering
 without spending time lecturing to them. This fits well with the
 tigris.org mission of promoting open source software engineering,
 and previous efforts, like <a
 href="http://argouml.tigris.org/">ArgoUML</a> to ease adoption of
 software engineering tools and practices in industry. The content
 of specific templates came from our understanding of software
 engineering literature, our experience on software development
 projects, and our understanding of cognitive challenges of
 engineering decision-making.
 </dd>

  <dt>What is the competition for ReadySET?</dt>

<dd>The main alternative to ReadySET is to do it yourself and
 reinvent the wheel or try to generalize from whatever documents you
 produced on your last project. That pattern leads to many
 individuals in our industry trying to develop their own methodology
 as they move from project to project and company to company.
 ReadySET is an attempt to gather that same knowledge from many
 people and share it more effectively. There are also products such
 as <a
 href="http://www.merant.com/News/PR/PR_02182003.asp">EssentialSET</a>
 and <a href="http://www-306.ibm.com/software/awdtools/rup/">RUP</a>.</dd>

 </dl>

 <h3>Download and Install</h3>

 <dl>
  <dt>How can I obtain ReadySET?</dt>

  <dd><a href="http://readyset.tigris.org/servlets/ProjectDocumentList">Download it</a>.
  Please, see the <a href="http://readyset.tigris.org/">ReadySET homepage</a>.</dd>

  <dt>What licence covers ReadySET?</dt>

  <dd>The <a href="../templates/readyset-license.html">ReadySET
  license</a> is a BSD-style license.</dd>

  <dt>What do I need to use ReadySET?</dt>

<dd>A web browser and a text editor or HTML editor. Please see our
 list of <a href="recommended-tools.html">recommended tools</a>.</dd>

<dd>It is also strongly recommended that you use a web server, a
 version control system, and web-based issue tracking system. You
 can work through setting up these tools yourself, or use a
 Collaborative Development Environment such as <a
 href="http://www.collab.net/">CollabNet's SourceCast</a>.</dd>

  <dt>How do I install ReadySET?</dt>

<dd>Simply unarchive it. Make a copy of the template files to use
 as your project documents.</dd>

  <dt>How do I upgrade from an older version of ReadySET?</dt>

  <dd>For any users not using CVS for their own project:
   simply copy-and-paste any desired text from the new templates
    into your project documents.
  </dd>

  <dd>For users that use CVS for their own project: you can use CVS's
    <a
    href="http://cvsbook.red-bean.com/cvsbook.html#Tracking_Third-Party_Sources__Vendor_Branches_">vendor
    branch</a> feature to help you merge the latest changes from the
    ReadySET project into your project.  Follow these <a
    href="HOWTO-upgrade.html">upgrade steps</a>.
  </dd>

 </dl>

 <h3>Main Concepts</h3>

 <dl>
  <dt>What is a "ReadySET template"?</dt>

  <dd>It is an HTML file that with sample text that you should use to
  create project documents.</dd>

  <dt>What is a "project document"?</dt>

  <dd>It is an HTML file, copied from a ReadySET template, that
  contains specific information about your project.</dd>

  <dt>What is a "prompt"?</dt>

<dd>In most other document template sets, the templates are
 basically outlines with headings and subheadings. In ReadySET
 subheadings are written in the form of a question or prompt. That
 helps make the documents more self-explanatory and easier for other
 stakeholders to quickly read or write an answer to.</dd>

  <dt>What are the colored bars in the right-hand margin?</dt>

<dd>Those bars indicate sections of sample text. They are
 explicitly marked so that you can see at a glance which parts have
 been filled in and which parts are still the original sample text.
 Once you edit the text, you should remove the HTML attribute
 class="sample1" to remove the bar.</dd>

  <dt>Why are there multiple answers (and colored bars) to each prompt?</dt>

<dd>Rather than give a long explanation of the meaning of each
 prompt, ReadySET includes a few sample answers to most prompts.
 That works best when one of the sample answers includes ideas that
 relate to your specific project. In many cases, much of the process
 of filling in a template is reduced to "chipping away" at the sample
 text by removing text that does not apply to your project.</dd>

  <dt name="chipaway">What is "chipping away"?</dt>

  <dd>The term "chipping away" comes from an old joke: when a sculptor
  is asked how he carved a marble statue of a horse, he replies "It
  was easy, I just started with a big block of marble and chiped away
  everything that did not look like a horse."</dd>

  <dt>What is an "attached worksheet"?</dt>

<dd>The idea is similar to filling in an IRS form and using
 worksheets to calculate subtotals or make specific decisions. That
 is to say, there is a hierarchy to the templates: there are the main
 templates, and then worksheets for specific topics. We have divided
 the information into several files so that each file is focused on
 one topic, and so that each file can be worked on by one person in a
 reasonable amount of time.</dd>

  <dt>What is the "process impact" box about?</dt>

<dd>The process impact box explains where the current template fits
 into the software development process. It usually includes a brief
 comment on who should create the document, and who would be expected
 to make use of it. You can change the process impact box, but you
 should not need to.</dd>

  <dt>What is a "checklist"?</dt>

  <dd>There are two kinds of checklists:
   <ul>
    <li>Many of the templates have a section with questions that help
    you check your work in that template.  Often the sample answers to
    the questions prompt you to take some corrective action.</li>

    <li>For design and code review meetings, there are links to
    guidelines and checklists that help you identify common errors in
    those artifacts.</li>
   </ul>
  </dd>

  <dt>What is a "sticky note"?</dt>

<dd>The idea is similar to a post-it note attached to a document
 that tells you do "sign here" or fill in a certain part. There are
 two types of sticky notes:
 <ul>
 <li>TODO: Instructs you on how to fill in the template. This is
 the minimum that you need to do. One of the main goals of ReadySET
 is to help your team quickly carry out basic software
 engineering activities. The TODO sticky notes make that easy by
 making the templates more self-explanatory.</li>

<li>TIP: Helps you think of better ways to fill in the template.
 One of the other main goals of ReadySET is to help your team make
 better decisions that can make your whole project more successful.
 The TIP sticky notes help with that.</li>
 </ul>

After you have done what the sticky note says, you can delete the
 sticky note. In the HTML file, they are marked with class="sticky".
 </dd>

  <dt>Why do some links have dashed underlines?</dt>

<dd>Those are links to the definitions of terms. They are visually
 different so that readers whill know that they can quickly read the
 definition of that term without being side-tracked. Also, the
 dashed underlines do not appear when the document is printed.</dd>

 </dl>

 <h3>Configuring and Customizing ReadySET</h3>

 <dl>

<dt>One of the ReadySET templates is not needed for my project. How
 do I remove it?</dt>

  <dd>Just delete it, and remove any links to it.</dd>

  <dt>How do I add a new file to the set?</dt>

<dd>Just open a new file in your HTML editor. Save the file, and
 add links to it from other templates as you see fit. You may want
 to copy an existing template and tear out all its content and put
 your content there instead, that way the new template will have the
 proper HTML HEAD elements, but these are simple anyway.</dd>

  <dt>How can I use ReadySET for projects using technologie like .NET or J2EE?</dt>

<dd>ReadySET does not have any complex customization tools. There
 are no "plug-ins" or meta-models. Those layers of abstraction make
 it harder to get started. ReadySET is just a set of XHTML
 templates. You can edit them any way you like, it is up to you and
 there is nothing preventing you from doing it. <a
 href="http://www.readysetpro.com/">ReadySET&nbsp;Pro</a> takes a more powerful
 approach that does have a bit of a learning curve, but scales well
 to corporate usage.</dd>

  <dt>How can I add "Company Proprietary" to every page?</dt>

<dd>That text is already there in a paragraph with CSS
 class="legal1". Normally that CSS style is invisible. You can make
 it visible by editing css/inst.css to uncomment the line "display:
 block !important". If you need to change the text, you can use a
 global search and replace in your text editor.</dd>

  <dt>Who uses ReadySET?</dt>

  <dd>Stay tuned to the ReadySET mailing list for user testimonials.</dd>

 </dl>

 <h3>Contributing to the Project</h3>

 <dl>

 <dt>Who can contribute to this project?</dt>

 <dd>Everyone is welcome, especially project managers or team leads
 who have first-hand experience on many projects where templates like
 these would have helped.</dd>

 <dt>How can someone start to contribute?</dt>

<dd>Make sure that you are familiar with the templates, then send
 your comments to the project mailing list and we will go from there.
 Only a core group of developers will have commit access, but others
 can make contributions via the mailing list and we will review them
 and integrate changes.</dd>

<dd>Please do not send in any proprietary or copyrighted content. We
 will have to immediately delete it. E.g., if you have a document
 template that you use at your current company, please do not send it.
 Instead, you can give us a few bullet points or examples on specific
 things that you think help make that type of document more useful
 based on your general experience. Of course, you should never send
 in any actual document that contains any actual information about
 your business, product plans, schedules, budgets, personnel, or
 customers.</dd>

  <dt>Who is contributing to ReadySET?</dt>

  <dd>Stay tuned to the ReadySET mailing list for information.</dd>

 </dl>

 <h3>Other Questions</h3>

<dl>
 <dt>My question is not on this page. How do I find the answer?</dt>

<dd>Your question may have already been asked and answered, to find
 it: search the project <a
 href="http://readyset.tigris.org/servlets/SummarizeList?listName=dev">mail
 archives</a> and <a
 href="http://readyset.tigris.org/servlets/ProjectIssues">issue
 tracking system</a>. If you still don't find it, you can ask the
 question on the the ReadySET developers' mailing list or you can
 enter an issue. You must subscribe to the mailing list before you
 may post. For commercial support and training, see <a
 href="http://www.readysetpro.com/">ReadySET&nbsp;Pro</a>. </dd>

 </dl>

</div>
</div>

</body>
</html>

[opengtoolkit-cvs] deab/Software Project Multi-Map/ReadySET-0-9-1/docs HOWTO-upgrade.html,NONE,1.1 f

[opengtoolkit-cvs] deab/Software Project Multi-Map/ReadySET-0-9-1/docs HOWTO-upgrade.html,NONE,1.1 faq.html,NONE,1.1 recommended-tools.html,NONE,1.1 release-notes-0-9-0.html,NONE,1.1 release-notes-0-9-1.html,NONE,1.1