<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"><head><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii"><meta name=Generator content="Microsoft Word 14 (filtered medium)"><!--[if !mso]><style>v\:* {behavior:url(#default#VML);}
o\:* {behavior:url(#default#VML);}
w\:* {behavior:url(#default#VML);}
.shape {behavior:url(#default#VML);}
</style><![endif]--><style><!--
/* Font Definitions */
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;}
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
@font-face
{font-family:Tahoma;
panose-1:2 11 6 4 3 5 4 4 2 4;}
@font-face
{font-family:Verdana;
panose-1:2 11 6 4 3 5 4 4 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman","serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
p.MsoAcetate, li.MsoAcetate, div.MsoAcetate
{mso-style-priority:99;
mso-style-link:"Balloon Text Char";
margin:0in;
margin-bottom:.0001pt;
font-size:8.0pt;
font-family:"Tahoma","sans-serif";}
span.yiv737507292028292122-05122011
{mso-style-name:yiv737507292028292122-05122011;}
span.EmailStyle19
{mso-style-type:personal-reply;
font-family:"Calibri","sans-serif";
color:#1F497D;}
span.BalloonTextChar
{mso-style-name:"Balloon Text Char";
mso-style-priority:99;
mso-style-link:"Balloon Text";
font-family:"Tahoma","sans-serif";}
.MsoChpDefault
{mso-style-type:export-only;
font-size:10.0pt;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]--></head><body lang=EN-US link=blue vlink=purple><div class=WordSection1><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'>Not necessarily, but usually, I suspect. </span><span style='font-size:11.0pt;font-family:Wingdings;color:#1F497D'>J</span><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'><o:p></o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'>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.<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'>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!<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'><br>Works for us pretty well!<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'>Z<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D'><o:p> </o:p></span></p><div><div style='border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in'><p class=MsoNormal><b><span style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>From:</span></b><span style='font-size:10.0pt;font-family:"Tahoma","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<o:p></o:p></span></p></div></div><p class=MsoNormal><o:p> </o:p></p><div><div><p class=MsoNormal style='background:white'><span style='color:black'>That's what I was thinking. It sounds more like marketing copy than user guide content.<o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:black'><o:p> </o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:black'>Nadine<o:p></o:p></span></p></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'><p class=MsoNormal style='background:white'><span style='color:black'><o:p> </o:p></span></p><div><div><div class=MsoNormal align=center style='text-align:center;background:white'><span style='font-size:10.0pt;font-family:"Arial","sans-serif";color:black'><hr size=1 width="100%" align=center></span></div><p class=MsoNormal style='margin-bottom:12.0pt;background:white'><b><span style='font-size:10.0pt;font-family:"Arial","sans-serif";color:black'>From:</span></b><span style='font-size:10.0pt;font-family:"Arial","sans-serif";color:black'> Jeff Coatsworth <<a href="mailto:jeff.coatsworth@jonassoftware.com">jeff.coatsworth@jonassoftware.com</a>><br><b>To:</b> "<a href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a>" <<a 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'><o:p></o:p></span></p><div id=yiv737507292><div><p class=MsoNormal style='background:white'><span class=yiv737507292028292122-05122011><span style='font-size:10.0pt;font-family:"Arial","sans-serif";color:blue'>It's called "marketing" ;>)</span></span><span style='color:black'><o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:black'><o:p> </o:p></span></p><div class=MsoNormal align=center style='text-align:center;background:white'><span style='color:black'><hr size=2 width="100%" align=center></span></div><p class=MsoNormal style='margin-bottom:12.0pt;background:white'><b><span style='font-size:10.0pt;font-family:"Tahoma","sans-serif";color:black'>From:</span></b><span style='font-size:10.0pt;font-family:"Tahoma","sans-serif";color:black'> <a href="mailto:framers-bounces@lists.frameusers.com">framers-bounces@lists.frameusers.com</a> <a 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 href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a><br><b>Subject:</b> documentation best practices</span><span style='color:black'><o:p></o:p></span></p><div><div><p class=MsoNormal style='background:white'><span style='font-size:10.0pt;font-family:"Verdana","sans-serif";color:black'>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.<o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='font-size:10.0pt;font-family:"Verdana","sans-serif";color:black'> <o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='font-size:10.0pt;font-family:"Verdana","sans-serif";color:black'>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. <o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='font-size:10.0pt;font-family:"Verdana","sans-serif";color:black'> <o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='font-size:10.0pt;font-family:"Verdana","sans-serif";color:black'>Any thoughts?<o:p></o:p></span></p></div></div></div></div><p class=MsoNormal style='margin-bottom:12.0pt;background:white'><span style='color:black'><br>_______________________________________________<br><br><br>You are currently subscribed to framers as <a href="mailto:generic668@yahoo.ca">generic668@yahoo.ca</a>.<br><br>Send list messages to <a href="mailto:framers@lists.frameusers.com">framers@lists.frameusers.com</a>.<br><br>To unsubscribe send a blank email to<br><a 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/generic668%40yahoo.ca" target="_blank">http://lists.frameusers.com/mailman/options/framers/generic668%40yahoo.ca</a><br><br>Send administrative questions to <a 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><o:p></o:p></span></p></div></div></blockquote></div></div></div></body></html>