Skip to main content

Documentation Guidelines

Here you can find templates for Documentation pages, FAQ, guidelines for images, features and how to use markdown. Access the links below to navigate:

→ Access FAQ guidelines
→ Access Markdown features
→ Access Images guidelines

Guidelines for Documentation​

Grammar
• When writing about modules or Carol's funcionalities, always capitalize, eg.: Tenants, Connectors, Data Model.

• You can also highlight this names by using `` eg.: Tenants.

• Do not translate modules or funcionalities, unless necessary to explain it's meaning, eg.: "Em Data Subscription (Inscrição de dados)...".

Tips
• Try to be as concise as possible, avoiding unnecessary explanations. Instead of explaining every component that is be shown on a screen, try adding an image or guiding the user to desire action by describing location and component type, eg.: "Access by clicking on "Manage" button on the top right corner".

• Use details or notes to summarize content that does not need to be always visible, like further instructions or some extra tips. To see more details about this components, access Markdown features.

Documentation page template​

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis lacinia cursus malesuada. Quisque ultricies maximus scelerisque. Integer sed ex at justo sodales maximus non sit amet lacus. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.

Donec sit amet maximus eros. Cras sem nisi, egestas vitae magna ut, vulputate consectetur purus. Proin et lorem velit. Sed porttitor finibus est. Vivamus pharetra id nisl eu commodo. Nullam sed dolor vitae ligula egestas egestas. Aenean dapibus malesuada fermentum. Nunc rutrum urna odio, vel suscipit libero tristique in. Vivamus ut nunc eget eros luctus viverra. Integer id diam a turpis finibus pharetra id vitae eros.

nota

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis lacinia cursus malesuada.

Subtitle example​

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis lacinia cursus malesuada. Quisque ultricies maximus scelerisque. 

import imagename from './/img/imagename.webp';

`<left><img src={imagename} width="400" /></left>`

 

info

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis lacinia cursus malesuada. Quisque ultricies maximus scelerisque.

Subtitle example​

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis lacinia cursus malesuada. Quisque ultricies maximus scelerisque.