Skip to content

[TAREFA] Criação do Diagrama de Arquitetura de Alto Nível (High-Level Architecture) #30

@Eduwilll

Description

@Eduwilll

Contexto e Justificativa

É necessário criar uma representação visual macro do projeto para facilitar o entendimento de stakeholders e novos desenvolvedores.
Este diagrama deve ilustrar "O que é" o projeto, mostrando como as peças se conectam desde o ambiente local do desenvolvedor até a entrega dos relatórios de vulnerabilidade. Ele serve para validar o fluxo de dados e a integração entre os componentes de desenvolvimento, versionamento, CI/CD e segurança.

Critérios de Aceite (Definition of Done)

  • O diagrama inclui a Developer Workstation (VS Code, Plugins Solidity).
  • O diagrama inclui o SCM (GitHub).
  • O diagrama inclui o CI/CD Server (GitHub Actions).
  • Existe um agrupamento claro para Segurança contendo as ferramentas (Slither, Mythril, Echidna).
  • O diagrama inclui o ambiente de Blockchain de teste (Anvil/Hardhat Network).
  • O diagrama mostra o Output final (Relatórios, Dashboards, Defect Dojo).
  • O arquivo do diagrama (PNG/SVG) foi salvo na pasta /docs/diagrams.
  • O diagrama foi adicionado à Wiki e ao README principal.

Tipo de Trabalho

Documentação ✍️

Recursos Adicionais (Opcional)

  • Ferramenta sugerida: Draw.io ou Mermaid.js (Live Editor).
  • Referência: Arquitetura de referência DevSecOps tradicional adaptada para Web3.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No fields configured for Task.

Projects

Status

In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions