| Title | Source code doesn't refer to its documentation |
| Status | closed |
| Priority | essential |
| Assigned user | Richard Brooksby |
| Product | project |
| Organization | Ravenbrook |
| Description | The Integrator's Guide and the design documents refer to the code in some detail, but the code doesn't refer back. This means that developers may forget to bring the manuals and design up to date when they change the code. |
| Analysis | All modules need to have introductions that set out the requirements that the module is designed to meet. They should also be formatted as documents.
Go through the Integrator's Guide. Whenever it refers to the code, make references back from the code to the manual. Similarly for the design documents. |
| How found | inspection |
| Evidence | <http://info.ravenbrook.com/mail/2001/03/22/16-24-46/0.txt> |
| Observed in | 1.0.5 |
| Introduced in | 1.0.0 |
| Created by | Gareth Rees |
| Created on | 2001-03-22 17:25:37 |
| Last modified by | Gareth Rees |
| Last modified on | 2010-10-06 21:38:41 |
| History | 2001-03-22 GDR Created. |