Skip to main content

​
Arquitetura de Informação: Visão Centrada em Ecossistemas

Este documento define a nova organização da documentação da Zentek, eliminando a visão comercial de “Planos/Assinaturas” e focando nas Capacidades Técnicas organizadas por Ecossistemas.

​
Diagrama Visual (Building Blocks)

+=======================================================================+
|                        ZENTEK DEVELOPER HUB                           |
|                 (Portal Unificado de Documentação)                    |
+===================================+===================================+
                                    |
                                    v
+-----------------------------------------------------------------------+
|                       SECTIONS (ECOSYSTEMS)                           |
|  (Baseado em _contexts/zentek - A "Alma" do Produto)                  |
+-----------------------------------------------------------------------+
|                                                                       |
|  +-------------------+   +-------------------+   +-------------------+|
|  | 🏠 CASA CONECTADA |   | 🛡️ PROTEÇÃO DIGITAL|   | 🏥 SAÚDE & BEM... ||
|  +---------+---------+   +---------+---------+   +---------+---------+|
|            |                       |                       |          |
|  +---------v---------+   +---------v---------+   +---------v---------+|
|  |    OVERVIEW       |   |    OVERVIEW       |   |    OVERVIEW       ||
|  | (Pitch, Missão,   |   | (Pitch, Missão,   |   | (Pitch, Missão,   ||
|  |  Target - vindo   |   |  Target - vindo   |   |  Target - vindo   ||
|  |  do Contexto)     |   |  do Contexto)     |   |  do Contexto)     ||
|  +-------------------+   +-------------------+   +-------------------+|
|            |                       |                       |          |
|  +---------v---------+   +---------v---------+   +---------v---------+|
|  |  CAPABILITIES     |   |  CAPABILITIES     |   |  CAPABILITIES     ||
|  | (Features/Cob.)   |   | (Features/Cob.)   |   | (Features/Cob.)   ||
|  |                   |   |                   |   |                   ||
|  | > Assist. Resid.  |   | > Monitoramento   |   | > Telemedicina    ||
|  | > Automação       |   | > Antivírus       |   | > Desc. Farmácia  ||
|  +---------+---------+   +---------+---------+   +---------+---------+|
|            |                       |                       |          |
|  +---------v---------+   +---------v---------+   +---------v---------+|
|  |  API REFERENCE    |   |  API REFERENCE    |   |  API REFERENCE    ||
|  | (Contextual)      |   | (Contextual)      |   | (Contextual)      ||
|  |                   |   |                   |   |                   ||
|  | POST /iot/device  |   | POST /cyber/monit |   | POST /health/sched||
|  | GET /iot/status   |   | GET /cyber/advise |   |                   ||
|  +-------------------+   +-------------------+   +-------------------+|
|                                                                       |
+-----------------------------------------------------------------------+
                                    |
+-----------------------------------v-----------------------------------+
|                        CORE SERVICES (Shared)                         |
|           (Onde fica a "Cola" técnica, não o Produto)                 |
+-----------------------------------------------------------------------+
|  > AUTHENTICATION (x-api-key)                                         |
|  > SUBSCRIPTION ENGINE (POST /subscriptions) *Técnico, não Produto*   |
|  > WEBHOOKS & EVENTS                                                  |
+-----------------------------------------------------------------------+

​
Análise de Aproveitamento de Dados

​
1. O que aproveitamos do Contexto (_contexts/zentek)?

MUITO. Os arquivos de contexto atuais são ricos em definições de negócio que preencherão a camada de Overview e Capabilities de cada Ecossistema.
  • Missão & Target: Vai direto para a introdução de cada seção (Ex: “Para quem é o Cyber Protection?”).
  • Descrição de Produtos: O texto que descreve “O que é o produto” vira a documentação da Feature.
    • Exemplo: O texto sobre “Monitoramento de Vazamento” em 02-cyber_protection_product.md vira a página docs/ecosystems/digital/features/monitoring.mdx.

​
2. Onde fica a API?

A API será distribuída de forma híbrida:
  1. API Contextual (Dentro do Ecossistema):
    • Endpoints específicos de um produto ficam dentro da seção daquele produto.
    • Exemplo: Os endpoints /cyber/* (Monitoramento, Advise) que vimos no _API_APIARY_ZENTEK.md ficarão dentro da seção Proteção Digital. Isso facilita para o dev que quer implementar aquele produto.
  2. API Core (Seção “Developers” ou “Core”):
    • Endpoints utilitários e de gestão que atravessam todos os produtos.
    • Exemplo: O endpoint /subscriptions (criar assinatura, renovar) é uma ferramenta administrativa. Ele não pertence ao “Cyber” ou “Casa”, ele serve a todos. Ele fica numa seção dedicada a Gestão de Assinaturas & Integração.

​
3. O Fim da Visão de “Planos”

Não documentaremos “Plano Gold” ou “Plano Silver”. Documentaremos “O que você pode fazer”.
  • O “Plano” é apenas uma configuração JSON que agrupa essas features no momento da venda (via endpoint /subscriptions), mas a documentação técnica foca na funcionalidade.

​
Próximos Passos Sugeridos

  1. Mapear Endpoints -> Ecossistemas: Ler o _API_APIARY_ZENTEK.md e marcar qual endpoint pertence a qual Ecossistema.
  2. Estruturar Pastas: Criar as pastas ecosystems/{nome}/features e ecosystems/{nome}/api.
  3. Migrar Conteúdo: Quebrar os MDs de contexto em features individuais.