Re: [mv] minivend--interchange documentation

[Chris Rapier <rapier@psc.edu>]

******    message to minivend-users from Chris Rapier <rapier@psc.edu>     ******

"Greg (Sonny) Cook" wrote:
> 
> ******    message to minivend-users from "Greg (Sonny) Cook" <sonny@akopia.com>     ******
> 
> Hi all,
> By way of introduction, I am one of the developers at Akopia.  I have
> taken on (bravely IMHO) the task of documentation organization for our
> next release of intervend. 

I commend and salute you on this task. I do not envy you though.

First step is to clearly determine what is good documentation. Second is
to determine your audience. Both steps are damn hard and have to be
taken into consideration throughout the entire process. I'd have
something less fuzzy for you that these broad statements but my brain
has not been functioning up to par as of late.

> Even though I am personally opposed to
> documentation, I have a grand vision for a complete set of documents of
> the project.  

Hurm. Being a huge fan of documentation and having been seriously
involved with a tech writer this does fill me with no small amount of
dread.

> I'd like to determine what sort of
> documentation people would like to see.  

As many have said, clear examples are a necessity. The optimal solution
would be a cookbook in addition to the standard documentation. Many
times you find interesting examples, solutions and information in a
cookbook that simplely don't fit into the structure of a products main
documentation.
-
To unsubscribe from the list, DO NOT REPLY to this message.  Instead, send
email with 'UNSUBSCRIBE minivend-users' in the body to Majordomo@minivend.com.
Archive of past messages: http://www.minivend.com/minivend/minivend-list