[OpenMadrigal-developers] Rewrite of Madrigal documentation
Bill Rideout
brideout at haystack.mit.edu
Mon Oct 17 08:51:34 EDT 2005
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
More information about the OpenMadrigal-developers
mailing list