Documentação X-Adm¶

Bem-vindo à plataforma de documentação da X-Adm Informática. Aqui você encontra, num lugar só, a documentação de todos os projetos da empresa.

O que tem aqui¶

Padrões e templates — a constituição da documentação (o que documentamos, para quem e qual o mínimo) e os templates prontos para copiar.
Infraestrutura — como funcionam Coolify, Forgejo, Traefik e o restante da nossa infraestrutura.
Aplicações — a documentação de cada aplicação: visão geral, design docs, decisões (RDs) e guias de usuário.
API Reference — referência técnica gerada do código (Javadoc/dartdoc).
Glossário — os termos de negócio (combustíveis, transporte, fiscal) num vocabulário único.

A documentação de cada aplicação vive no docs/ do repositório dela, no Forgejo.

Devs: a doc muda no mesmo PR que muda o código.
Não-devs: edite o arquivo .md pela interface web do Forgejo e salve — a mudança aparece aqui em ~2 minutos.

Em dúvida sobre o que ou como documentar, comece pela constituição.