documentation best practices

[Neeraj Jain]

At one time I had to write "under development" for the functionalities that have yet not been released. 
 
_________________________________________________
Dream -- the only movie you watch with your eyes shut
Regards, 
NJ
http://www.neerajjain8.com
 


 


________________________________
 From: Jeff Coatsworth <jeff.coatsworth at jonassoftware.com>
To: "framers at lists.frameusers.com" <framers at lists.frameusers.com> 
Sent: Tuesday, 6 December 2011 3:51 AM
Subject: RE: documentation best practices
 

It's called "marketing" ;>)


________________________________
 From: framers-bounces at lists.frameusers.com 
[mailto:framers-bounces at lists.frameusers.com] On Behalf Of hessiansx4
Sent: Monday, December 05, 2011 5: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?
_______________________________________________


You are currently subscribed to framers as neerajjain8 at yahoo.com.

Send list messages to framers at lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscribe at lists.frameusers.com
or visit http://lists.frameusers.com/mailman/options/framers/neerajjain8%40yahoo.com

Send administrative questions to listadmin at frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20111206/c8f1016d/attachment-0001.htm>