Difference between revisions of "Talk:Main Page"

From WeBWorK_wiki
Jump to navigation Jump to search
(New page: As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following: * a description of webwork for the student, professor, and administrator * system re...)
 
Line 1: Line 1:
  +
== Complete set of docs ==
  +
  +
''Found on the TWiki:''
  +
  +
<blockquote>
 
As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following:
 
As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following:
   
Line 25: Line 30:
   
 
(this list originally from <code>Message-ID: <20031001034004.A92569@gate.math.rochester.edu></code>)
 
(this list originally from <code>Message-ID: <20031001034004.A92569@gate.math.rochester.edu></code>)
  +
</blockquote>
 
 
 
-- Main.SamHathaway - 10 Nov 2003
 
-- Main.SamHathaway - 10 Nov 2003

Revision as of 16:42, 29 February 2008

Complete set of docs

Found on the TWiki:

As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following:

  • a description of webwork for the student, professor, and administrator
  • system requirements (in the installation manual)
  • installation instructions (installation manual)
  • configuration instructions
    • basic configuration is in installation manual
    • a comprehensive list of course environment variables is now in the comments of global.conf and database.conf, but needs to be made accessible. convert to POD?
    • Constants.pm has POD docs, but they have to get put on the wiki
    • the NETPBM stuff is in the installation manual (but really should go away!!!)
  • task-oriented usage instructions
    • admin tasks (like course creation)
      • course admin tasks
    • instructor tasks
    • student tasks
  • command line script documentation
  • library reference (this is/will be POD)
  • pg language reference
    • basics
    • cookbook techniques
    • standard macro packages and modules (some of this exists in POD form on Frontier site)
    • extending pg
  • how to get support
  • contributing to the webwork project (patches, donations, etc)

(this list originally from Message-ID: <20031001034004.A92569@gate.math.rochester.edu>)

-- Main.SamHathaway - 10 Nov 2003