Category:Documentation

From COSSAN Wiki
Jump to: navigation, search

Cossanxdoc.png

Structure of this documentation

The documentation consists in four parts:

  1. User Manual (it documents the essential features of the software. It is structured in accordance with the workflow encountered in most use cases of COSSAN-X).
  2. Tutorial (it includes examples and use cases, in which the features of the software are utilized for solving representative problems).
  3. Reference Manual (it assembles the description of all class methods and GUI elements, including the admissible parameters of each method or element).
  4. Theory Manual (It presents the theoretical background in a concise and consolidated manner, in order to facilitate the understanding of the utilized methods and concepts).


Please note that cross-references between different manuala are encourage.

Futhermore: 

The documentation of the UML cossan structure can be found here

An example how to construct/edit a page is Here


Subcategories

This category has the following 3 subcategories, out of 3 total.

Pages in category "Documentation"

The following 2 pages are in this category, out of 2 total.