I think this is a good format. Thinking about the number of different
packages we may have documentation for, and how to keep them from getting
outdated, I'd suggest a couple of changes. Mainly, I think it would be good
to make the page specific to the package, but not to a particular place that
it is installed.
So, for the system, I'd add the detail of the different places the package
is installed - the cluster, UNIXGEN, available for install on local
machines, etc.
For each specific location, I'd have the particular versions installed,
installed toolboxes or add on modules (for Matlab, R, etc.), info on how to
access the package (the module load, etc.), maybe a link to the user
documentation for that particular version, information about licensing (like
when the licenses for the old SAS/SPSS versions on UNIXGEN will expire),
etc.
I'd also try to keep the external links to a minimum - maybe just one link
to the main page for the software (and make it clear that this is an
external link). This is not likely to change, but the more detailed links
may change, and for some of the packages I've installed, clearly have
changed.
Some additional things we could put on the pages (where appropriate) - links
to tutorial pages, knowledge base articles, etc.
Also, it looks like you have setup the page so that all the software details
would be on one page - maybe it would be easier to have a separate page for
each package? The main software page could have a list of all of the
packages, and maybe also links to pages for software installed on RedHawk,
Unixgen, and software available for install on individual computers (Matlab,
SPSS, SAS, etc.) These pages could have lists of the specific packages on
that system, but for example the RedHawk and Unixgen pages would both link
to the same Matlab pages.
Do we have a plan for what the research computing web page is going to look
like?
Dave
-----Original Message-----
From: Research Computing Support [mailto:[log in to unmask]] On
Behalf Of Greg Reese
Sent: Thursday, April 06, 2006 4:00 PM
To: [log in to unmask]
Subject: Documentation template
Hey folks,
Please go to
http://www.units.muohio.edu/mcs/academictechnology/research_computing/soft-d
etails.shtml#descriptions_start
and take a look at the documentation for a program I've installed on the
cluster. We can use this format to document each program we load by just
copy-and-pasting the html text. Let me know if you have any comments or
suggestions.
Greg
----------------------------------------------------------------------------
--------
Greg Reese, Ph.D.
Senior Research Computing Specialist
Research Computing Support Group
Gaskill Hall, Room 352
Miami University
Oxford, OH 45056
(513)529-1411
[log in to unmask]
|
