MathGroup Archive 2008

[Date Index] [Thread Index] [Author Index]

Search the Archive

Re: Documentation - what is the big secret?

  • To: mathgroup at
  • Subject: [mg87567] Re: Documentation - what is the big secret?
  • From: "Dr. David Kirkby" <david.kirkby at>
  • Date: Sun, 13 Apr 2008 03:32:02 -0400 (EDT)
  • References: <fti3v2$oho$> <ftkbce$b8b$> <ftq547$ei$>

David Reiss wrote:
> I basically agree with David here.  I think that there is indeed a
> style of working that corresponds to the workflow in Workbench.  And I
> suspect that there are many who like to work with it.  However My
> approach to Mathematica programming (and I have done a **lot** of it
> over the years) is to code in notebooks and save to packages.  So it
> does make sense to include documentation tools inside of Workbench as
> WRI is in the process of doing.  

But this needs to be in addition to documenting the format of the 


> such tools in the next version of

> The way that I have created these has been to reverse engineer the
> examples that are included with Mathematica:

But it should not be necessary to reverse engineer files, as others have 

I assume there are internal documents in Wolfram Research detailing how 
to write documentation. Perhaps WRI could clean them up a bit and 
release them. One the whole, Mathematica's documentation is excellent, 
but it really seems to be let down in this area. I can think of no other 
area where the documentation is so poor, although there might be areas I 
don't know about.

> have devoted so far to this aspect of
> of tools for Documenting within
> follow-on releases of  So,

>   Frankly, the more folks who try and buy
> life/,
> Trial Version at:

Does it really need 6 links to in 
one message? I understand you want to sell it, but that amount of 
spamming just puts people off.

  • Prev by Date: Re: Product
  • Next by Date: Re: Re: what does Method->"HighDimensionalEmbedding" actually
  • Previous by thread: Re: Re: Documentation - what is the big secret?
  • Next by thread: Re: Documentation - what is the big secret?