documentation best practices

[Neeraj Jain]

What about inserting an asterik and saying "Conditions Apply"?
 
_________________________________________________
Dream -- the only movie you watch with your eyes shut
Regards, 
NJ
http://www.neerajjain8.com
 


 


________________________________
 From: "Syed Zaeem Hosain (Syed.Hosain at aeris.net)" <Syed.Hosain at aeris.net>
To: Writer <generic668 at yahoo.ca>; Jeff Coatsworth <jeff.coatsworth at jonassoftware.com>; "framers at lists.frameusers.com" <framers at lists.frameusers.com> 
Sent: Tuesday, 6 December 2011 5:45 AM
Subject: RE: documentation best practices
 

Not necessarily, but usually, I suspect. J
 
In our case, in some of our API specs, we sometimes send out information to our Customers for review and comment, before it is “released into production” so to speak.
 
We clearly identify this information as “Pre-Release” or “Draft”, with an introductory description that states very clearly that the functionality may not be available, and is subject to change when it is released … or withdrawn too!

Works for us pretty well!
 
Z
 
From:framers-bounces at lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Writer
Sent: Monday, December 05, 2011 2:27 PM
To: Jeff Coatsworth; framers at lists.frameusers.com
Subject: Re: documentation best practices
 
That's what I was thinking. It sounds more like marketing copy than user guide content.
 
Nadine
 
>
>________________________________
>
>From:Jeff Coatsworth <jeff.coatsworth at jonassoftware.com>
>To: "framers at lists.frameusers.com" <framers at lists.frameusers.com> 
>Sent: Monday, December 5, 2011 5:21:46 PM
>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 generic668 at yahoo.ca.
>
>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/generic668%40yahoo.ca
>
>Send administrative questions to listadmin at frameusers.com. Visit
>http://www.frameusers.com/ for more resources and info.
>
>
_______________________________________________


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/9071a2dc/attachment.htm>