CAWI documentation

Note

This is the internal GIDE version of the documentation. You may use the view/edit links at the top of each page to view or edit pages on gitlab.

About this documentation

This documentation is currently (March 2025) a work-in-progress to document the next CAWI system.

Each module of the CAWI system will have its own set of documentation authoried in Markdown, and the global "cawi-documentation" project will bring those individual pieces of documentation together.

At the moment, each module is presented in its own top-level navigation section, but we have the ability to combine them if we wish - e.g. the "cawi-language" and "cawi-engine" sections could be merged, with "cawi-language" defining the syntax, and "cawi-engine" defining the semantics - i.e. how the language is implemented.

It is intended that other aspects of the CAWI system (such as how to develop and deploy surveys, manage access control, question display options, quota and sample management) are documented independently - keeping the language/engine sections relatively clean and concise, and independent of the different deployment methods.

There will also be documentation aimed at both users and developers, and we have the ability to mark sections with flags, so different versions (e.g. internal or public) can be generated from the same source documents.