[OpenMadrigal-developers] Rewrite of Madrigal documentation

[John Holt]

Bill,

This is a good time to do this. The content outline looks good.

With regard to 2, as you know, we are in the process of completely
redoing the Haystack Website. To some level, the look and feel of all
pages will be rigorously prescribed. It's not entirely clear to what
extent this will apply to our open source projects, but I suspect that
Joe will expect Madrigal to follow the mandatory guidelines. He has
been very hands on in this, requiring that every detail be approved by
himself. Whether he does extend this to Madrigal or not, we expect that
the Haystack Web site will be more professional, accessible and
maintainable than now. So, we may well decide to have Madrigal follow
Haystack. The new site map is complete, an RFP will be sent to
several Web design firms this week and we expect to have approved a
design by early December. So, until then, we should concentrate
entirely on content.

John




> Date: Mon, 17 Oct 2005 08:51:34 -0400
> From: Bill Rideout <brideout at haystack.mit.edu>
> To: openmadrigal-developers at openmadrigal.org
> Subject: [OpenMadrigal-developers] Rewrite of Madrigal documentation
> 
> My final task before releasing Madrigal 2.4 is a drastic revision of the
> documentation.  Here are some of the goals:
> 
> 1.  Add two comprehensive tutorials on 1) Accessing data via the web
> interface, and 2) Accessing data via remote API's.
> 
> 2. Consistent navigation buttons to go the next, previous, table of
> contents, and Madrigal home page on every documentation page.
> 
> 3. Clean separation of user's guide, administrators guide, and guide to
> extending Madrigal.
> 
> Here's my suggested high level outline:
> 
> 1. Brief overview of Madrigal
> 
> 2. Madrigal User's Guide (How do I access Madrigal data?)
>     - Web interface tutorial
>     - Web interface reference guide
>     - Programmatic access to Madrigal data tutorial
>     - Programmatic access to Madrigal reference guide
> 
> 3. Madrigal Administration Guide
>     - Is Madrigal appropriate for my instrument?
>     - Installing Madrigal
>     - Creating Madrigal data files
>     - Creating and updating Madrigal experiments
>     - Other administrative tasks
> 
> 4. Extending Madrigal
>     - Internal API's
>     - Technical Reference Guide
> 
> Let me know if you have any comments.
> 
> Bill Rideout
> _______________________________________________
> OpenMadrigal-developers mailing list
> OpenMadrigal-developers at openmadrigal.org
> http://www.openmadrigal.org/mailman/listinfo/openmadrigal-developers
> 
> !DSPAM:43539e7812435295875166!