documentation best practices

[Owen, Clint]

If they insist, I would make sure that it is well-marked as a future
enhancement, perhaps is a separate section of the documentation.
 
I just had a situation where a major aircraft maker (the one that does
not start with a "B") gave all sorts of very specific information about
a software tool to make suppliers lives easier in a reference guide and
on their website. When I went to track down the tool I discovered that
it does not actually exist yet. Very frustrating.
 
Clint
 

 

Clint Owen | Sr. Technical Writer | Crane Aerospace & Electronics | +1
425 743 8674 | Fax: +1 425 743 8113

 

________________________________

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?

--------------------------------------------------------------------------------
Check out the new Crane Aerospace & Electronics Newsroom!
http://newsroom.craneae.com
Like us on Facebook!
http://www.facebook.com/home.php?#!/pages/Crane-Aerospace-Electronics/163305413682908

We value your opinion!  How may we serve you better? 
Please click the survey link to tell us how we are doing:
http://www.craneae.com/ContactUs/VoiceofCustomer.aspx
Your feedback is of the utmost importance to us. Thank you for your time.
--------------------------------------------------------------------------------
Crane Aerospace & Electronics Confidentiality Statement:
The information contained in this email message may be privileged and is 
confidential information intended only for the use of the recipient, or any 
employee or agent responsible to deliver it to the intended recipient. Any 
unauthorized use, distribution or copying of this information is strictly prohibited 
and may be unlawful. If you have received this communication in error, please notify 
the sender immediately and destroy the original message and all attachments from 
your electronic files.
--------------------------------------------------------------------------------
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20111205/045340ef/attachment.htm>