Should the documentation of a known issue change dependent on the stability of a product release?
I am writing the release documentation for a software product and a design flaw has been discovered after the code has been frozen. Does the documentation describing this issue change if the product is a beta release to selected customers only? What if the product is a 1.0 to be exposed to a public audience? What if no software patch is currently scheduled?
Related to How should I document a product release with an inherently flawed design?
This post was sourced from https://writers.stackexchange.com/q/33262. It is licensed under CC BY-SA 3.0.
1 answer
Beta or not does not matter, whether a patch exists does not matter, write it up. Document it.
Like your previous question, this is a business matter, not a documentation issue you should decide for yourself. You should document it, even if you have just ONE beta tester, whether or not a patch exists, and let your management decide if they are willing to risk any liability or negative publicity that may arise from a failure to document the behavior.
This should not be your decision, it should be the decision of somebody with fiscal responsibility for the fate of your company or employer.
0 comment threads
0 comment threads