Documentation

Documentation for XCIST will fall into four categories, described below. The first three will be somewhat formal manuals in the form of Word documents. These will be written by XCIST's primary developers but will be stored in the repository, so others can revise if they wish. The fourth category, "Tips and Tricks", will be Wiki pages that can be quickly written by anyone.

User manual - for users, by developers

This will be a relatively high-level manual directed at users who aren't concerned about how XCIST works "under the hood". This will focus on how to use XCIST's existing features. By necessity, some high-level discussion of the imaging system will be included but detailed discussion of imaging physics and XCIST's algorithms and implementation will be found in other documents (below).

Theory and Implementation - for advanced users and developers, by developers

This will be an in-depth manual directed at advanced users and developers. This will focus on imaging physics and XCIST's algorithms and implementation of those algorithms.

Software design - for developers, by developers

This will be a detailed manual directed at developers who want to revise existing code or add new features and functionality.

Tips and tricks - for users and developers, by users and developers

This is intended as a mechanism for anyone to make quick notes for themselves or others to refer to. These are Wiki pages and therefore can be produced and revised quickly and informally.