Wiki Style Guide

This page is a notice on how to edit RAGE analytics wiki pages. Please read this before contributing to the RAGE analytics wiki.

Wiki structure

Stakeholders considered

We currently consider five main stakeholders interested in RAGE analytics. Each of them has a personalized home page, all of which can be accessed from the RAGE Analytics Wiki home page:

1. Game developers
2. Analytics developers
3. Analytics users, including:
   • Teachers
   • Developers
4. User interested in complete information

Modules structure

Our wiki is divided into projects/modules. Each module includes an overview page, which contains general information and links to other pages in the project, briefly describing what can be found in each page. If some extra page is included in the project wiki, it should be added to the project overview page. For instance, if a new page is added containing information about A2, it should be explained in and linked from the A2 overview page.

In particular, the system overview page contains information for the whole RAGE analytics project, describing what each of the sub-projects contains. Therefore, if a new project is included the information should be added to the system overview page.

General Syntax

We use Markdown in this wiki, heres a reference.

Style

Notable syntax

• Wiki links are made using [ [ and ] ] (without the spaces) with a | (pipe) to separate text from link. For example:

[[rage-analytics front-end | Front end Overview]] renders this: rage-analytics front-end .

Every link to a project should link to its wiki overview page instead of its main GitHub page to ease the documentation reading process.

Figures

All figures should be numbered and descriptive by themselves i.e. their captions should contain enough information to understand the figure without reading the whole text around it.

Figures should be included to clarify the content and every time they have some relevance.

Technical terms

Use backtick to refer to technical terms as well as URL links or URL suffixes. For instance:

`admin` renders this: admin.