DSpace/dspace/docs/confluence/introduction.txt

h1. DSpace System Documentation: Introduction

DSpace is an open source software platform that enables organisations to:

*  capture and describe digital material using a submission workflow module, or a variety of programmatic ingest options 
*  distribute an organisation's digital assets over the web through a search and retrieval system 
*  preserve digital assets over the long term 
This system documentation includes a functional overview of the system, which is a good introduction to the capabilities of the system, and should be readable by non-technical folk. Everyone should read this section first because it introduces some terminology used throughout the rest of the documentation.

For people actually running a DSpace service, there is an installation guide, and sections on configuration and the directory structure. Note that as of DSpace 1.2, the administration user interface guide is now on-line help available from within the DSpace system.

Finally, for those interested in the details of how DSpace works, and those potentially interested in modifying the code for their own purposes, there is a detailed architecture and design section.

Other good sources of information are:

*  The DSpace Public API Javadocs. Build these with the command _mvn javadoc:javadoc_.
*  The [DSpace Wiki|http://wiki.dspace.org/|DSpace Wiki] contains stacks of useful information about the DSpace platform and the work people are doing with it. You are strongly encouraged to visit this site and add information about your own work. Useful Wiki areas are: 
** [A list of DSpace resources|http://wiki.dspace.org/DspaceResources|A list of DSpace resources]  (Web sites, mailing lists etc.)
** [Technical FAQ|http://wiki.dspace.org/TechnicalFaq|Technical FAQ]
** [A list of projects using DSpace|http://wiki.dspace.org/DspaceProjects|A list of projects using DSpace]
** [Guidelines for contributing back to DSpace|http://wiki.dspace.org/ContributionGuidelines|Guidelines for contributing back to DSpace]
* [www.dspace.org|http://www.dspace.org/|www.dspace.org]  has announcements and contains useful information about bringing up an instance of DSpace at your organization.
*  The [dspace-tech e-mail list on SourceForge|#|dspace-tech e-mail list on SourceForge] is the recommended place to ask questions, since a growing community of DSpace developers and users is on hand on that list to help with any questions you might have. The e-mail archive of that list is a useful resource.
*  The [dspace-devel e-mail list|#|dspace-devel e-mail list], for those developing with the DSpace with a view to contributing to the core DSpace code.