3.1 Home Page
The Home Page will be the main page that will give the user basic information on the documentation and will allow the user to navigate & search the different subsections that make up the documentation.
3.2 Getting Started
This section aims at answering some basic FAQ’s that users may have when they log into Maxxton Software (MXTS) for the very first time. This section will also cover basic things like changing the system and / or the content language of the software for instance.
3.3 Core Concepts
The core concepts page will centralize all of the information on Core Concepts. The main Core Concepts page explains what are Core Concepts & why are they important. Sub-pages of the main page will explain the different Core Concepts.
It is important to note that for an element to be considered a Core Concept, it needs to be a fundamental element of how MXTS / Newyse work and have a global, structural reach, meaning that it has a link or a connection across multiple modules, Managers (Reservation Manager, Finance Manager, etc…) and configurations made by the user. There should be a maximum of 15-20 Core Concepts for all of Maxxton Software.
Please note, that the creation of any new Core Concept sub-page needs to be discussed with the Documentation Team (Judy Dekker, Darshan Sangawar & Dmitry Finkel).
3.4 Sections
The sections page will aim to create high overview categories (parent pages) that will allow to bundle together multiple aspects & features of the software. It is important to note, that these sections are agnostic with regards to Maxxton Software and the different individual managers that exist (Finance Manager, Reservation Manager, etc…).
This means that these sections do not aim to be only focused on a specific individual module / Manager but rather focus on an overarching concept that tends to overlap across multiple ones. This is done on purpose as in practice, most configuration elements & features within MXTS reach across multiple Managers.
There are a total of 7 fixed sections under which all child-level documentation pages such as How-to guides & feature / functionality explanations need to be listed. Please see the list of sections below:
Finance & Administration
Rates & Availability
On-site operations
Marketing & Resort management
Reservations & 3rd Parties
Owners & customers
Users & rights
It is not allowed to create new sections. If you feel like a new section is needed, please discuss this with the Documentation Team.
3.5 How-to guides & feature explanations
How-to guides & feature explanations are specific pages that either explain a specific feature, functionality or goal or guide the user on a desired outcome. These pages are the biggest part of the documentation. They are the lowest child level pages in the documentation and each page of this category needs to be linked to one of the 7 sections described above.
3.6 FAQ
This section will cover the most asked questions by our customers and provide them with answers. It is exclusively aimed at answering general questions, as more specific questions will be managed directly in the how-to guides & feature explanation pages.
3.7 Glossary
This section will serve as an informational section that will give short definitions on different import elements within Maxxton & Maxxton Software as well as explain acronyms.