RevisionHistory
Revision History
Library
UsersGuide/Conventions/UsersGuide
Description
- The revision history needs to answer the question: What has changed and what are the improvements over the previous versions and revision.
- The revision history includes the documentation of the development history of each class and/or package.
- Version number, date, author and comments shall be included.
In case the version number is not known at the time of implementation,
a dummy version number shall be used, e.g.,
3.x.x
. The version date shall be the date of the latest change.
Example
<table border="1" cellspacing="0" cellpadding="2"> <tr> <th>Version</th> <th>Date</th> <th>Author</th> <th>Comment</th> </tr> ... <tr> <td>1.0.1</td> <td>2008-05-26</td> <td>A. Haumer<br>C. Kral</td> <td>Fixed bug in documentation</td> </tr> <tr> <td>1.0.0</td> <td>2008-05-21</td> <td>A. Haumer</td> <td>Initial version</td> </tr> </table>
This code appears then as in the "Revisions" section below.