documentation best practices
Writer
generic668 at yahoo.ca
Mon Dec 5 14:27:30 PST 2011
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.
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20111205/a90b5fb0/attachment.htm>
More information about the framers
mailing list