web:Documentação dos sites

De Documentação
Revisão de 23h40min de 21 de maio de 2023 por Peter (discussão | contribs)

Documentação da arquitetura e requisitos gerais dos sites do ITGS, válidas para o próprio site ITGS e todos os sites de projetos encubados.

Em uso nos seguintes sites, com diferenças e nuanças descritas nas respectivas documentações:

Pilares filosóficos

  1. Máximo reuso entre projetos.
    • O reuso se dá pela "copia/cola" da estrutura dos códigos-fonte e templates de um site para outro.
      Por exemplo do AdressForAll.org para o OSM.codes.
  2. Máximo de respeito aos formatos e padrões abertos consensuais.
    • HTML e CSS no conteúdo, REST na interatividade.
    • Respeito aos navegadores HTML maduros e historicamente respeitadores dos padrões abertos: Firefox e Chrome (não Microsoft).
  3. Conteúdo institucional em formato transparente, igualmente legível e rápido para todas as versões de sistema e navegador.
  4. Princípios básicos: Simplicidade Zen, "Separação das responsabilidades" e "Convenção sobre configuração".

Arquitetura e reuso do sistema

Sistemas de template: o template engine (processador) é alimentado pelos dados e o template mais adequado à visualização do tipo de dado.
Arquitetura "Outside server template system" para o conteúdo institucional.
Na prática é implementado como cache de server-side.
Server-side template system.
Client-side template system.


Os principais aspectos da arquitetura são relativos: ao sistema de template (ilustrado) e aos microserviços (web services).

O pilar da transparência levou à arquitetura diferenciada na publicação do conteúdo:

  • Conteúdo institucional via arquitetura "Outside server template system" (preferível) ou "Server-side template system".
  • O restante opcional, pode fazer também uso de "Client-side template system". Tipicamente a navegação intranet, depois do login seria client-side.

Estrutura e requisitos das páginas

...

  • Institucional

Frameworks e gestão de conteúdo

Foram tomadas as seguintes decisões de projeto para a construção de todos os sites:

  • Conteúdo de documentação técnica em Mediawiki: todos na wiki.addressforall.org, separando-se cada projeto através de namespaces.
  • Conteúdo institucional gerado como HTML estático por server-side building, com tecnologia NextJS.
  • Conteúdo institucional, visualização de dados, intranet e relatórios públicos: tecnologia ReactJS em server-side e client-side.

Demais decisões na implementação dos pilares

  • O conteúdo institucional deve ser publicado como HTML5-onlyContent e com interpretações visual (usuário humano) e robótica (marcação semântica) baseadas na mesma única fonte de verdade, conforme LexML-DOU dos diários oficiais.
  • ...