That should work. But I would only add new revision information for
major changes. Minor edits will not matter to most people.
I agree with David on the "major changes" only. In any process that is using
source code management, like subversion, you should track changes using the log
messages for each commit, not in the source code files.
Keeping a change log in a source code file sounds like a nice idea, until the
file has been around for several years and you get pages and pages of change
entries at the top of the file.
Readers of a document are not going to be interested in wading through a bunch
of revision notes. I would use the release notes for a release to note most
major revisions in the doc rather than keep a revisions history in the doc
itself. I.e., in the release notes for ooDialog 4.2.1, put "Added chapters 7
and 8 to the User Guide manual."
No reason for the change logs to be at the front of a source file or document.
Can be very useful at the end of source or in an appendix in a doc. (e.g., I
got lots of thanks for Appendix C in TRL 2nd Ed.).
[But yes 'corrected spelling error' is not useful in most cases :-).]
Mike
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_sfd2d_oct
_______________________________________________
Oorexx-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
