Fonte oficial de conhecimento funcional, técnico e operacional do projeto SIGEN.
Bem-vindo ao Portal de Documentação do SIGEN.
Este espaço centraliza informações sobre processos, módulos, regras de negócio, integrações, arquitetura, operação e decisões relevantes do projeto.
A documentação disponível neste portal deve representar o funcionamento atual do sistema, servindo como referência para Product Owners, analistas, desenvolvedores, QA, suporte, infraestrutura e gestores.
| Área | Descrição |
|---|---|
| Visão Geral do Projeto | Contexto, objetivos, escopo, stakeholders e principais informações do SIGEN |
| Processos do Projeto | Análise de requisitos, desenvolvimento, homologação, deploy e incidentes |
| Módulos do Sistema | Documentação funcional e técnica organizada por módulo |
| Regras de Negócio | Regras consolidadas que orientam o comportamento do sistema |
| Integrações | Serviços externos, APIs, dependências e fluxos de integração |
| Arquitetura | Componentes, ambientes, banco de dados e decisões técnicas |
| Operação | Monitoramento, troubleshooting, rollback e procedimentos operacionais |
| Releases | Alterações disponibilizadas em produção |
| Onboarding | Conteúdo inicial para novos integrantes do projeto |
O SIGEN é uma plataforma responsável por apoiar processos administrativos, cadastrais, financeiros, regulatórios e operacionais relacionados ao Sistema Cofen/Conselhos Regionais.
O sistema atende diferentes perfis de usuários e possui módulos, integrações e regras de negócio que evoluem continuamente.
Este portal tem como objetivo garantir:
Documentação sobre inscrições, categorias profissionais, reativações, suspensões, cancelamentos, certidões e demais processos cadastrais.
Documentação sobre débitos, anuidades, boletos, pagamentos por cartão, renegociações, repasses, taxas e relatórios financeiros.
Documentação sobre cadastros, inspeções, portarias, instituições fiscalizadas e processos relacionados à fiscalização.
Documentação sobre abertura, análise, tramitação, notificações, decisões e acompanhamento dos processos éticos.
Documentação dos relatórios operacionais, financeiros, gerenciais e integrações com ferramentas analíticas.
Documentação sobre usuários, permissões, configurações, parâmetros, tabelas auxiliares e gestão do sistema.
| Processo | Objetivo |
|---|---|
| Análise de Requisitos | Compreender a necessidade, definir regras e estruturar a solução |
| Desenvolvimento | Implementar e revisar as alterações do sistema |
| Testes | Validar critérios de aceite e comportamentos esperados |
| Homologação | Obter a validação funcional antes da produção |
| Deploy | Publicar alterações de forma controlada |
| Gestão de Incidentes | Registrar, analisar e solucionar falhas operacionais |
| Integração | Finalidade |
|---|---|
| Banco do Brasil | Boletos, pagamentos, webhooks e movimentações financeiras |
| PaguePlay | Operações relacionadas a pagamentos e renegociações |
| Keycloak | Autenticação, autorização e gerenciamento de acesso |
| Valid | Serviços relacionados à emissão de carteiras e certificados |
| Metabase | Dashboards, indicadores e consultas analíticas |
| API Unifica | Integrações relacionadas a processos cadastrais |
Utilize o menu lateral, os links desta página ou a pesquisa localizada na parte superior do portal.
A documentação deve ser atualizada sempre que uma demanda alterar:
Sempre que possível, utilize a estrutura:
| Papel | Responsabilidade |
|---|---|
| Analista de Requisitos | Documentação funcional, regras, fluxos e critérios de aceite |
| Desenvolvedor | Documentação técnica, APIs, integrações e decisões de implementação |
| QA | Cenários validados, exceções e comportamentos testados |
| Infraestrutura | Ambientes, deploy, monitoramento, backup e recuperação |
| Product Owner | Governança, revisão funcional e atualização do processo |
| Suporte | Registro de procedimentos, problemas conhecidos e soluções |
Uma demanda somente deve ser considerada concluída quando a documentação impactada estiver atualizada.
| Ferramenta | Finalidade |
|---|---|
| Wiki.js | Documentação oficial e consolidada do funcionamento atual |
| Taiga | Gestão de demandas, Histórias de Usuário, tarefas e sprints |
| Google Drive | Documentos formais, planilhas, apresentações e anexos |
| GitLab | Código-fonte, versionamento técnico e pipelines |
| GLPI | Chamados, incidentes e solicitações de suporte |
O Wiki.js não substitui essas ferramentas. Ele conecta e consolida o conhecimento gerado durante todo o ciclo de vida do projeto.
Não devem ser armazenados neste portal:
Essas informações devem permanecer nos mecanismos corporativos apropriados para gestão de segredos e credenciais.
Projeto: SIGEN
Finalidade: Documentação funcional, técnica e operacional
Responsável pela governança: Product Owner do projeto
Atualização: Contínua, conforme evolução do produto
Status: Portal em implantação e validação