documentation best practices

[Syed Zaeem Hosain (Syed.Hosain@aeris.net)]

We carefully mark any new unreleased functionality as "Pre-Release" or "Draft" - even when that content goes along with released information in the same document.

Z

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/421405e7/attachment.htm>