Portal de documentacao Zenit
Objetivo
Apresentar a estrutura da documentacao da Zenit e indicar por onde comecar, conforme o perfil de quem esta consultando o portal.
Escopo
O portal /docs reune conteudo sobre produtos, operacao, arquitetura e integracoes do ecossistema Zenit. Parte do acervo e publica. Parte e destinada ao uso interno do time.
Publico-alvo
- usuarios que precisam de guias e conceitos de produto;
- times internos que precisam de especificacoes e runbooks;
- desenvolvedores que precisam de arquitetura, setup e exemplos.
Conceitos principais
- a documentacao e escrita em Markdown e versionada junto com o codigo;
- os documentos sao classificados por tipo, visibilidade e status;
- o conteudo publico e renderizado no site;
- o conteudo interno segue o mesmo modelo, mas vai para um build separado.