Pular para conteúdo

SpaceShield AI · Documentação (MkDocs)

Documentação viva do projeto spacesecurity.github.io, construída com MkDocs e organizada segundo a metodologia ágil (Scrum + Kanban) adotada no desenvolvimento do produto.

Esta documentação cobre dois eixos:

  1. Metodologia ágil aplicada ao desenvolvimento do site e do produto SpaceShield AI — papéis, cerimônias, backlog de épicos, sprints e board Kanban.
  2. Testes de Intrusão (Pentest) — o módulo PENTEST do painel administrativo, documentado em todas as suas fases, tipos, ferramentas, frameworks e hands-on labs — além da arquitetura de painéis/telas (CSS e JavaScript) do site.

Para a documentação de arquitetura de sistema (nível C4/ByteByteGo), veja docto/README.md (fora deste site MkDocs). Para credenciais/acessos administrativos, veja docto/ACESSOS-ADMIN.md.

Como rodar esta documentação localmente

cd docto
pip install -r requirements.txt

mkdocs serve      # http://127.0.0.1:8000 com live-reload
mkdocs build      # gera site estático em docto/site/

Mapa da documentação

Seção Conteúdo
Metodologia Ágil Scrum + Kanban, papéis, cerimônias
Backlog de épicos Épicos do produto mapeados aos painéis admin
Sprints & roadmap Histórico de sprints e entregas
Board Kanban Board por painel/módulo (To Do · Doing · Review · Done)
Definition of Done Critérios de aceite por tipo de item
Fases do Pentest 5 fases · kill chain completo
Tipos de Pentest 8 tipos de teste de intrusão
Ferramentas 30+ ferramentas por categoria
Frameworks PTES · OWASP · OSSTMM · NIST · MITRE ATT&CK · TIBER-EU
Checklist metodológico Checklist ISO 27001 por fase
Hands-On Labs 8 labs práticos com comandos e flags
Arquitetura · Visão geral Painéis admin, estrutura de pastas
Arquitetura · CSS style/ organizado por painel/tela
Arquitetura · JavaScript javascript/ organizado por subpasta
LinkedIn Ads B2B Migração Google Ads → LinkedIn Ads B2B

Fonte da verdade

Todo o conteúdo técnico desta documentação foi extraído diretamente do código-fonte do projeto:

  • javascript/pentest/pentest.js — dados de fases, tipos, ferramentas, frameworks, labs e checklist
  • style/ — estrutura de CSS por painel/tela
  • javascript/ — estrutura de módulos JS por subpasta
  • javascript/marketing/marketing.js — módulo LinkedIn Ads B2B
  • index.html — inventário de painéis/abas do sistema

Isso garante que a documentação não diverge do sistema real — qualquer atualização no código deve ser refletida aqui na próxima sprint de documentação (ver Definition of Done).