documentation best practices

[Lea Rush]

As someone who both develops and documents software, I can only answer with
a hearty “Hear hear!”. I think you’re exactly right, and I hope you can get
them to see the light.

 

Good luck,

Lea


_________________________________ 

Lea Rush 
Software and Documentation Specialist 
Astoria-Pacific International 
 <http://www.astoria-pacific.com> www.astoria-pacific.com <http://www.a> 
ph: 800-536-3111 
fax:  503-655-7367 
 <mailto:lea at astoria-pacific.com> lea at astoria-pacific.com

 

Please consider the environment before printing this email.
`·.¸¸.·´¯`·.¸.·´¯`·...¸ ><((((º>`·.¸¸.·´¯`·.¸.·´¯`·...¸><((((º>
 
NOTICE OF CONFIDENTIALITY
 
This communication is from Astoria-Pacific International and is intended to
be confidential and solely for the use of the persons or entities addressed
above.  If you are not an intended recipient, be aware that the information
contained herein may be protected from unauthorized use by privilege or law,
and any copying, distribution, disclosure, or other use of this information
is prohibited.  If you have received this communication in error, please
contact the sender by return email or telephone (503) 657-3010 immediately,
and delete or destroy all copies.  Thank you for your cooperation. 

 

From: framers-bounces at lists.frameusers.com
[mailto:framers-bounces at lists.frameusers.com] On Behalf Of hessiansx4
Sent: Monday, December 05, 2011 2:56 AM
To: framers at lists.frameusers.com
Subject: documentation best practices

 

I could use some insight into a situation I haven't encountered before
today: how does one best respond to a request (read: order) to include
something in their product's documentation about a functionality that will
not be released with the upcoming release (it will still be in development)
but is hoped to be ready "shortly" (whatever that means) after the product
is released.

 

I've politely pointed out that industry best practice is to document what IS
as opposed to what WILL BE and that certain liabilities might be incurred if
promises are made and then something goes wrong. 

 

Any thoughts?

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20111205/43cc6847/attachment.htm>