I need some practical advice on writing revision notes and document versioning. What information do you include in revision notes? Do you have any reference info on document versioning (vs. product versioning)? Thanks.

Views: 71

Comment by Robin Senor on January 21, 2012 at 9:40pm

What I include in release/revision notes depends on the nature of the revision.

If the release includes features, I typically include what features are new, what issues are open, what issues have been closed since the last release, and any open issues with major workarounds. The release of "open issues" is sometimes a political...can of worms.

For minor releases or patch fixes, I deliver the above minus the new feature description.

I personally do not change version my documentation outside the product release; I think it is a tricky precedent to set that you will deliver your documentation product outside the software product.

Hope this helps.

Comment by Robin Senor on January 21, 2012 at 9:56pm

your company should have a versioning standard that defines what numbered releases include features...check with your R&D manager.

Comment by Karen Michele on January 23, 2012 at 4:09pm

Thanks, Robin; I appreciate the info.

Comment

You need to be a member of Technical Writing World to add comments!

Join Technical Writing World

Sponsors

Become a sponsor

© 2012   Created by Arnold Burian.

Badges  |  Report an Issue  |  Terms of Service