Changelog da documentação¶
Este changelog registra mudanças realizadas na documentação da Drexies Agro.
Os registros desta página descrevem exclusivamente a evolução do conteúdo documental. A inclusão de uma tela, funcionalidade, regra ou integração na documentação não significa que o sistema tenha sido criado ou alterado durante o mesmo período.
Ciclo atual de adaptação documental¶
Como não foi comprovada uma data individual para cada página adaptada, os trabalhos realizados foram consolidados em um único ciclo, sem associação a versão ou release do sistema.
Estrutura do portal¶
- criada a documentação da Drexies Agro a partir da estrutura-base MkDocs, preservando a organização, o tema, os recursos visuais e a navegação existentes;
- adaptada a Página inicial com a apresentação da plataforma e a visão resumida dos seus principais módulos;
- adaptada a página de Primeiros passos com orientações sobre acesso, autenticação, navegação, perfis, tema e encerramento da sessão;
- adaptada a Entrada da documentação funcional e técnica, reunindo os caminhos para as áreas documentadas.
Documentação funcional e regras de negócio¶
- publicada a Documentação de Telas e Funcionalidades, organizada conforme as telas e os fluxos identificados no código da Drexies Agro;
- publicado o Dicionário de Indicadores e Regras de Negócio, com definições, cálculos, classificações, fallbacks técnicos e Pontos a validar;
- publicado o FAQ, com respostas baseadas nos comportamentos comprovados da aplicação;
- publicado o Glossário, reunindo termos funcionais, comerciais e técnicos utilizados na documentação.
Dados, integrações e atualização¶
- publicada a página de Fontes de Dados e Linhagem, distinguindo fontes internas e externas, dados persistidos, consultas sob demanda e cálculos da aplicação;
- publicada a página de Atualização e Sincronização, com os mecanismos identificados de consulta, cache, invalidação e armazenamento dos dados.
Acessos e segurança¶
- publicada a página de Autenticação, Perfis, Permissões e RLS, diferenciando autenticação, autorização no frontend, escopos organizacionais e segurança aplicada no banco.
Governança da documentação¶
- adaptada a página de Governança e evolução da documentação, com critérios para revisão documental, orientação de consulta ao changelog e esclarecimento sobre a ausência de um roadmap funcional comprovado;
- substituído o histórico anterior deste changelog pelos registros comprovados do ciclo de adaptação da documentação da Drexies Agro.
Escopo deste registro¶
Este ciclo registra alterações na documentação. Ele não registra nem pressupõe:
- criação ou modificação das funcionalidades do sistema;
- publicação de uma nova versão da aplicação;
- data de implantação em ambiente remoto;
- entrega de itens de roadmap ou backlog de desenvolvimento.
Como registrar novas entradas¶
Novas entradas devem ser adicionadas somente quando houver evidência da alteração documental. Sempre que possível, registre:
- a data comprovada da revisão;
- as páginas afetadas;
- o conteúdo incluído, alterado ou removido;
- os Pontos a validar resolvidos ou acrescentados;
- a distinção entre revisão da documentação e eventual mudança comprovada no sistema.