PT EN
Back to site

Documentation Portal

Documentation that lives in a distant repository, an outdated PDF or a parallel wiki is documentation nobody reads. And documentation behind a login screen is documentation half the people who need it never open — whoever is evaluating the platform, whoever went looking for an answer before requesting access, whoever got the link from a colleague. That is why the DATTA manual is a site of its own, open, served at /documentacao/. You are reading this page in it right now.

How to access it

  • Directly, without login: at /documentacao/ (the addresses /documentacao and /documentacao.html lead to the same place). All product, usage and functional administration documentation is open: it asks for no user, no password, and does not depend on the platform being up in order to be read.
  • From the platform: the Documentação item in the side menu, which opens the site in a new tab. Every page has its own URL — you can bookmark it and send the link of any passage to a colleague.
  • Restricted section: Plataforma & Operações — internal architecture, runbooks, infrastructure, installer and consoles — is not on the site. Its address leads into the platform, which asks for login and only delivers the content to people with the PLATFORM_VIEW permission or an administrator profile. Entering the section already requires login, not just opening a page inside it.
  • All the site shows about restricted content is the count. A section that has restricted pages displays a single entry — "13 restricted pages" — with a padlock and the way into the platform. The title of an operations page is information too: names like Cluster Console describe the very topology the page protects, so the site does not publish them.

Two languages, zero friction

The portal is bilingual (Brazilian Portuguese and English):

  • Automatic detection: on the first visit, the language follows your browser — English for browsers in English, Portuguese for the rest.
  • Manual switch: PT | EN buttons at the top. The choice is saved in your browser and applies to future visits.
  • Friendly fallback: a page not yet translated into English shows the Portuguese version with a notice at the top — you never land on an empty page.

What the portal offers

  • Search (Ctrl/Cmd + K): searches titles, descriptions and headings, in both languages, with results grouped by section and keyboard navigation.
  • On this page: a side outline with the open page's headings, to jump straight to the section you need (on wide screens).
  • Previous / Next: sequential navigation between pages, crossing sections — you can read the documentation like a book.
  • Section cards: the home page and each section show cards with the title and description of the pages.
  • Internal links: links between documents become site navigation; a link to a restricted document becomes text with a notice, never an error and never a dead link.
  • Theme and mobile: the site uses the same visual identity as the platform, follows its light/dark theme and is responsive — the sidebar becomes a sliding menu on small screens.
  • Still readable with JavaScript off: every page is an HTML document served ready. With JavaScript disabled you lose search and the theme button; the text, the navigation and the links keep working.

Practical example — finding the answer in 30 seconds

  1. From any portal page, press Ctrl/Cmd + K.
  2. Type triagem. Results appear as you type, grouped by section — user guides, administration, and so on.
  3. Use the arrow keys to select Triagem em Lote and press Enter.
  4. In the Nesta página panel, click the heading of your specific question — you land directly on the section, without scrolling the whole document.
  5. Want to send it to a colleague abroad? Click EN and share the URL — it opens in the English version.

Where the content comes from

The portal is generated together with the platform, from the product's own documentation base. Three practical consequences for readers:

  • What you see matches the installed version. There is no manual synchronization between the documentation and the system — updating the platform updates the site.
  • Every page exists in Portuguese and English. Portuguese is the source; when a translation does not exist yet, the page is served in Portuguese and flagged as such, rather than appearing empty.
  • The page is written at generation time, not assembled in your browser. That is what lets it open fast, be indexable and not depend on a session.

The documentation ships in two partitions. The public one — usage, administration and API guides — is the open site. The Plataforma & Operações one gathers runbooks, infrastructure, installer and internal architecture, which describe network addresses, commands and topology: it never enters the site, and inside the platform it is delivered only to people with the PLATFORM_VIEW permission, through an authenticated path. The split is checked on every generation — in both directions, including confirming that no restricted page became a file of the site — and covered by an automated test.

Related pages: shell navigation, access control and permissions.