<html><body><div style="color:#000; background-color:#fff; font-family:arial, helvetica, sans-serif;font-size:12pt"><div><span>What about inserting an asterik and saying "Conditions Apply"?</span></div><div> </div><div><font color="#0000ff" size="2" face="arial, helvetica, sans-serif"><span style="COLOR:red;FONT-SIZE:12pt;FONT-WEIGHT:bold;"></span></font></div><div><font color="#ff0000" size="2" face="arial, helvetica, sans-serif">_________________________________________________</font><div class="MsoNormal"><span style="COLOR:red;"><font size="2" face="arial, helvetica, sans-serif">Dream -- the only movie yo</font></span><span style="white-space: nowrap; font-size: 13px; font-family: Arial; " class="Apple-style-span"><font class="Apple-style-span" color="#ff0000">u watch with your eyes shut</font></span></div></div><div><font color="#0000ff" size="2" face="arial, helvetica, sans-serif">Regards,
<br>NJ<br>http://www.neerajjain8.com<br> <br><br></font></div><div><font color="#0000ff"></font><font size="2" face="arial, helvetica, sans-serif"> </font></div><div><br></div> <div style="font-size: 12pt; font-family: arial, helvetica, sans-serif; "> <div style="font-size: 12pt; font-family: 'times new roman', 'new york', times, serif; "> <font size="2" face="Arial"> <hr size="1"> <b><span style="font-weight:bold;">From:</span></b> "Syed Zaeem Hosain (Syed.Hosain@aeris.net)" <Syed.Hosain@aeris.net><br> <b><span style="font-weight: bold;">To:</span></b> Writer <generic668@yahoo.ca>; Jeff Coatsworth <jeff.coatsworth@jonassoftware.com>; "framers@lists.frameusers.com" <framers@lists.frameusers.com> <br> <b><span style="font-weight: bold;">Sent:</span></b> Tuesday, 6 December 2011 5:45 AM<br> <b><span style="font-weight: bold;">Subject:</span></b> RE: documentation best practices<br> </font> <br><div
id="yiv1622957709"><style><!--
#yiv1622957709
_filtered #yiv1622957709 {font-family:Wingdings;panose-1:5 0 0 0 0 0 0 0 0 0;}
_filtered #yiv1622957709 {font-family:Wingdings;panose-1:5 0 0 0 0 0 0 0 0 0;}
_filtered #yiv1622957709 {font-family:Calibri;panose-1:2 15 5 2 2 2 4 3 2 4;}
_filtered #yiv1622957709 {font-family:Tahoma;panose-1:2 11 6 4 3 5 4 4 2 4;}
_filtered #yiv1622957709 {font-family:Verdana;panose-1:2 11 6 4 3 5 4 4 2 4;}
#yiv1622957709
#yiv1622957709 p.yiv1622957709MsoNormal, #yiv1622957709 li.yiv1622957709MsoNormal, #yiv1622957709 div.yiv1622957709MsoNormal
{margin:0in;margin-bottom:.0001pt;font-size:12.0pt;font-family:"serif";}
#yiv1622957709 a:link, #yiv1622957709 span.yiv1622957709MsoHyperlink
{color:blue;text-decoration:underline;}
#yiv1622957709 a:visited, #yiv1622957709 span.yiv1622957709MsoHyperlinkFollowed
{color:purple;text-decoration:underline;}
#yiv1622957709 p.yiv1622957709MsoAcetate, #yiv1622957709 li.yiv1622957709MsoAcetate, #yiv1622957709 div.yiv1622957709MsoAcetate
{margin:0in;margin-bottom:.0001pt;font-size:8.0pt;font-family:"sans-serif";}
#yiv1622957709 span.yiv1622957709-05122011
{}
#yiv1622957709 span.yiv1622957709EmailStyle19
{font-family:"sans-serif";color:#1F497D;}
#yiv1622957709 span.yiv1622957709BalloonTextChar
{font-family:"sans-serif";}
#yiv1622957709 .yiv1622957709MsoChpDefault
{font-size:10.0pt;}
_filtered #yiv1622957709 {margin:1.0in 1.0in 1.0in 1.0in;}
#yiv1622957709 div.yiv1622957709WordSection1
{}
--></style><div><div class="yiv1622957709WordSection1"><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; ">Not necessarily, but usually, I suspect. </span><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: Wingdings; ">J</span><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; "></span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; "> </span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; ">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.</span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; ">
</span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; ">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!</span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; "><br>Works for us pretty well!</span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; "> </span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; ">Z</span></div><div class="yiv1622957709MsoNormal"><span style="font-size: 11pt; color: rgb(31, 73, 125); font-family: sans-serif; ">
</span></div><div><div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in;"><div class="yiv1622957709MsoNormal"><b><span style="font-size: 10pt; font-family: sans-serif; ">From:</span></b><span style="font-size: 10pt; font-family: sans-serif; "> framers-bounces@lists.frameusers.com [mailto:framers-bounces@lists.frameusers.com] <b>On Behalf Of </b>Writer<br><b>Sent:</b> Monday, December 05, 2011 2:27 PM<br><b>To:</b> Jeff Coatsworth; framers@lists.frameusers.com<br><b>Subject:</b> Re: documentation best practices</span></div></div></div><div class="yiv1622957709MsoNormal"> </div><div><div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="color:black;">That's what I was thinking. It sounds more like marketing copy than user guide content.</span></div></div><div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="color:black;"> </span></div></div><div><div
class="yiv1622957709MsoNormal" style="background:white;"><span style="color:black;">Nadine</span></div></div><div><blockquote style="border:none;border-left:solid #1010FF 1.5pt;padding:0in 0in 0in 4.0pt;margin-left:3.75pt;margin-top:3.75pt;margin-bottom:5.0pt;"><div class="yiv1622957709MsoNormal" style="background:white;"><span style="color:black;"> </span></div><div><div><div class="yiv1622957709MsoNormal" align="center" style="text-align:center;background:white;"><span style="font-size: 10pt; color: black; font-family: sans-serif; "><hr size="1" width="100%" align="center"></span></div><div class="yiv1622957709MsoNormal" style="margin-bottom:12.0pt;background:white;"><b><span style="font-size: 10pt; color: black; font-family: sans-serif; ">From:</span></b><span style="font-size: 10pt; color: black; font-family: sans-serif; "> Jeff Coatsworth <<a rel="nofollow" ymailto="mailto:jeff.coatsworth@jonassoftware.com" target="_blank"
href="mailto:jeff.coatsworth@jonassoftware.com">jeff.coatsworth@jonassoftware.com</a>><br><b>To:</b> "<a rel="nofollow" ymailto="mailto:framers@lists.frameusers.com" target="_blank" href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a>" <<a rel="nofollow" ymailto="mailto:framers@lists.frameusers.com" target="_blank" href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a>> <br><b>Sent:</b> Monday, December 5, 2011 5:21:46 PM<br><b>Subject:</b> RE: documentation best practices</span><span style="color:black;"></span></div><div id="yiv1622957709"><div><div class="yiv1622957709MsoNormal" style="background:white;"><span class="yiv1622957709-05122011"><span style="font-size: 10pt; color: blue; font-family: sans-serif; ">It's called "marketing" ;>)</span></span><span style="color:black;"></span></div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="color:black;">
</span></div><div class="yiv1622957709MsoNormal" align="center" style="text-align:center;background:white;"><span style="color:black;"><hr size="2" width="100%" align="center"></span></div><div class="yiv1622957709MsoNormal" style="margin-bottom:12.0pt;background:white;"><b><span style="font-size: 10pt; color: black; font-family: sans-serif; ">From:</span></b><span style="font-size: 10pt; color: black; font-family: sans-serif; "> <a rel="nofollow" ymailto="mailto:framers-bounces@lists.frameusers.com" target="_blank" href="mailto:framers-bounces@lists.frameusers.com">framers-bounces@lists.frameusers.com</a> <a rel="nofollow" ymailto="mailto:[mailto:framers-bounces@lists.frameusers.com]" target="_blank" href="mailto:[mailto:framers-bounces@lists.frameusers.com]">[mailto:framers-bounces@lists.frameusers.com]</a> <b>On Behalf Of </b>hessiansx4<br><b>Sent:</b> Monday, December 05, 2011 5:56 AM<br><b>To:</b> <a rel="nofollow"
ymailto="mailto:framers@lists.frameusers.com" target="_blank" href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a><br><b>Subject:</b> documentation best practices</span><span style="color:black;"></span></div><div><div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="font-size: 10pt; color: black; font-family: sans-serif; ">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.</span></div></div><div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="font-size: 10pt; color: black; font-family: sans-serif; "> </span></div></div><div><div
class="yiv1622957709MsoNormal" style="background:white;"><span style="font-size: 10pt; color: black; font-family: sans-serif; ">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. </span></div></div><div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="font-size: 10pt; color: black; font-family: sans-serif; "> </span></div></div><div><div class="yiv1622957709MsoNormal" style="background:white;"><span style="font-size: 10pt; color: black; font-family: sans-serif; ">Any thoughts?</span></div></div></div></div></div><div class="yiv1622957709MsoNormal" style="margin-bottom:12.0pt;background:white;"><span style="color:black;"><br>_______________________________________________<br><br><br>You are currently subscribed to framers as <a rel="nofollow"
ymailto="mailto:generic668@yahoo.ca" target="_blank" href="mailto:generic668@yahoo.ca">generic668@yahoo.ca</a>.<br><br>Send list messages to <a rel="nofollow" ymailto="mailto:framers@lists.frameusers.com" target="_blank" href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a>.<br><br>To unsubscribe send a blank email to<br><a rel="nofollow" ymailto="mailto:framers-unsubscribe@lists.frameusers.com" target="_blank" href="mailto:framers-unsubscribe@lists.frameusers.com">framers-unsubscribe@lists.frameusers.com</a><br>or visit <a rel="nofollow" target="_blank" href="http://lists.frameusers.com/mailman/options/framers/generic668%40yahoo.ca">http://lists.frameusers.com/mailman/options/framers/generic668%40yahoo.ca</a><br><br>Send administrative questions to <a rel="nofollow" ymailto="mailto:listadmin@frameusers.com" target="_blank" href="mailto:listadmin@frameusers.com">listadmin@frameusers.com</a>. Visit<br><a rel="nofollow"
target="_blank" href="http://www.frameusers.com/">http://www.frameusers.com/</a> for more resources and info.<br><br></span></div></div></div></blockquote></div></div></div></div></div><br>_______________________________________________<br><br><br>You are currently subscribed to framers as <a ymailto="mailto:neerajjain8@yahoo.com" href="mailto:neerajjain8@yahoo.com">neerajjain8@yahoo.com</a>.<br><br>Send list messages to <a ymailto="mailto:framers@lists.frameusers.com" href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a>.<br><br>To unsubscribe send a blank email to<br><a ymailto="mailto:framers-unsubscribe@lists.frameusers.com" href="mailto:framers-unsubscribe@lists.frameusers.com">framers-unsubscribe@lists.frameusers.com</a><br>or visit <a href="http://lists.frameusers.com/mailman/options/framers/neerajjain8%40yahoo.com" target="_blank">http://lists.frameusers.com/mailman/options/framers/neerajjain8%40yahoo.com</a><br><br>Send
administrative questions to <a ymailto="mailto:listadmin@frameusers.com" href="mailto:listadmin@frameusers.com">listadmin@frameusers.com</a>. Visit<br><a href="http://www.frameusers.com/" target="_blank">http://www.frameusers.com/</a> for more resources and info.<br><br><br> </div> </div> </div></body></html>