Generate software development documentation with the inclusion by reference method
Source: TechRepublic
One technique for generating software development documentation which deserves more attention is the idea of including documentation by reference.
Generating the necessary documentation in a software development project is usually not the part of the process most lovingly embraced by developers. Finding a way to create documentation with the least amount of pain is a typical priority. One technique for generating software development documentation which deserves more attention is the idea of including documentation by reference. In other words, refer readers to a more comprehensive source for the detailed information while maintaining a reasonable summary in the document itself. This download explains how inclusion by reference works and suggests ways this method may save you time and effort.What method do you use to create documentation for your development projects? Do you think the inclusion by reference outlined in the download/article is feasible in your organization? Do you have a better method?
This download is also available as a TechRepublic article.
Generating the necessary documentation in a software development project is usually not the part of the process most lovingly embraced by developers. Finding a way to create documentation with the least amount of pain is a typical priority. One technique for generating software development documentation which deserves more attention is the idea of including documentation by reference. In other words, refer readers to a more comprehensive source for the detailed information while maintaining a reasonable summary in the document itself. This download explains how inclusion by reference works and suggests ways this method may save you time and effort.What method do you use to create documentation for your development projects? Do you think the inclusion by reference outlined in the download/article is feasible in your organization? Do you have a better method?
This download is also available as a TechRepublic article.
| Format: | Size: | 53.00 | |
| Version: | 1.0 | Date: | Mar 2006 |
| Downloads: | 4019 |



