documentation best practices

2011-12-08 Thread Dick Spierings
Subject: documentation best practices Message-ID: 1323082560.94393.yahoomail...@web114713.mail.gq1.yahoo.com Content-Type: text/plain; charset=iso-8859-1 I could use some insight into a situation I haven't encountered before today: how does one best respond to a request (read: order

documentation best practices resolved

2011-12-08 Thread hessiansx4
A big hearty thank you (xie xie) to all who responded to my question about including not-yet-released features in software documentation. The jury is still out on how I'll handle the situation but your answers were helpful and thought-provoking! This list is the

documentation best practices

2011-12-07 Thread Dick Spierings
meusers.com" Subject: documentation best practices Message-ID: <1323082560.94393.YahooMailNeo at web114713.mail.gq1.yahoo.com> Content-Type: text/plain; charset="iso-8859-1" I could use some insight into a situation I haven't encountered before today: how does one best res

documentation best practices resolved

2011-12-07 Thread hessiansx4
A big hearty "thank you" (xie xie) to all who responded to my question about including "not-yet-released" features in software documentation. The jury is still out on how I'll handle the situation but your answers were helpful and thought-provoking! This list is the BEST! -- next

Re: documentation best practices

2011-12-06 Thread Neeraj Jain
: Jeff Coatsworth jeff.coatswo...@jonassoftware.com To: framers@lists.frameusers.com framers@lists.frameusers.com Sent: Tuesday, 6 December 2011 3:51 AM Subject: RE: documentation best practices It's called marketing ;) From: framers-boun...@lists.frameusers.com

Re: documentation best practices

2011-12-06 Thread Neeraj Jain
) syed.hos...@aeris.net To: Writer generic...@yahoo.ca; Jeff Coatsworth jeff.coatswo...@jonassoftware.com; framers@lists.frameusers.com framers@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

RE: Documentation Best Practices

2011-12-06 Thread Galanter, Lea
Don't know if anyone has mentioned this, but the reason why you're not supposed to mention what will be in future versions is for legal reasons. You should not make forward-looking statements because the company could be held legally responsible for them. And since none of us can guarantee what

Re: documentation best practices

2011-12-06 Thread Grant Hogarth
@lists.frameusers.com framers@lists.frameusers.com *Sent:* Monday, December 5, 2011 5:21:46 PM *Subject:* RE: documentation best practices It's called marketing ;) *From:* framers-boun

Re: Documentation Best Practices

2011-12-06 Thread Writer
Nicely put. Nadine From: Galanter, Lea lea.galan...@fticonsulting.com To: framers@lists.frameusers.com Sent: Tuesday, December 6, 2011 1:30:28 PM Subject: RE: Documentation Best Practices Don't know if anyone has mentioned this, but the reason why you're

Re: documentation best practices

2011-12-06 Thread Steve Rickaby
At 02:56 -0800 5/12/11, hessiansx4 wrote: 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

documentation best practices

2011-12-06 Thread Neeraj Jain
From: Jeff Coatsworth To: "framers at lists.frameusers.com" Sent: Tuesday, 6 December 2011 3:51 AM Subject: RE: documentation best practices It's called "marketing" ;>) From: framers-bounces at lists.frameusers.com [mailto:framer

documentation best practices

2011-12-06 Thread Neeraj Jain
in (Syed.Hosain at aeris.net)" To: Writer ; Jeff Coatsworth ; "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

Documentation Best Practices

2011-12-06 Thread Galanter, Lea
Don't know if anyone has mentioned this, but the reason why you're not supposed to mention what will be in future versions is for legal reasons. You should not make forward-looking statements because the company could be held legally responsible for them. And since none of us can guarantee what

Documentation Best Practices

2011-12-06 Thread Writer
Nicely put. Nadine > > From: "Galanter, Lea" >To: framers at lists.frameusers.com >Sent: Tuesday, December 6, 2011 1:30:28 PM >Subject: RE: Documentation Best Practices > >Don't know if anyone has mentioned this, but the

documentation best practices

2011-12-06 Thread Steve Rickaby
At 02:56 -0800 5/12/11, hessiansx4 wrote: >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

documentation best practices

2011-12-05 Thread hessiansx4
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) 

RE: documentation best practices

2011-12-05 Thread Lea Rush
. Thank you for your cooperation. From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of hessiansx4 Sent: Monday, December 05, 2011 2:56 AM To: framers@lists.frameusers.com Subject: documentation best practices I could use some insight

RE: documentation best practices

2011-12-05 Thread Owen, Clint
From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of hessiansx4 Sent: Monday, December 05, 2011 2:56 AM To: framers@lists.frameusers.com Subject: documentation best practices I could use some insight into a situation I

RE: documentation best practices

2011-12-05 Thread Jeff Coatsworth
It's called marketing ;) From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of hessiansx4 Sent: Monday, December 05, 2011 5:56 AM To: framers@lists.frameusers.com Subject: documentation best practices I could use

Re: documentation best practices

2011-12-05 Thread Writer
Subject: RE: documentation best practices It's called marketing ;) From: framers-boun...@lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of hessiansx4 Sent: Monday, December 05, 2011 5:56 AM To: framers@lists.frameusers.com Subject

documentation best practices

2011-12-05 Thread hessiansx4
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

documentation best practices

2011-12-05 Thread Lea Rush
mediately, and delete or destroy all copies. Thank you for your cooperation. From: framers-boun...@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: documentatio

documentation best practices

2011-12-05 Thread Owen, Clint
1 425 743 8113 From: framers-boun...@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 us

documentation best practices

2011-12-05 Thread Jeff Coatsworth
It's called "marketing" ;>) From: framers-bounces at lists.frameusers.com [mailto:framers-boun...@lists.frameusers.com] On Behalf Of hessiansx4 Sent: Monday, December 05, 2011 5:56 AM To: framers at lists.frameusers.com Subject: documentation best

documentation best practices

2011-12-05 Thread Writer
That's what I was thinking. It sounds more like marketing copy than user guide content. Nadine > > From: Jeff Coatsworth >To: "framers at lists.frameusers.com" >Sent: Monday, December 5, 2011 5:21:46 PM >Subject: RE: documentation

documentation best practices

2011-12-05 Thread Syed Zaeem Hosain (syed.hos...@aeris.net)
siansx4 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 best practices

2011-12-05 Thread Syed Zaeem Hosain (syed.hos...@aeris.net)
users.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

documentation best practices

2011-12-05 Thread Grant Hogarth
amers at lists.frameusers.com" > *Sent:* Monday, December 5, 2011 5:21:46 PM > *Subject:* RE: documentation best practices > > It's called "marketing" ;>) > > > *From:* f