Documentação

Aprenda a usar o Archyl.

Getting started

C4 model

  • Visão Geral do Modelo C4 — Aprenda sobre o modelo C4 e como o Archyl o implementa para documentação de arquitetura
  • Elementos e Estilização — Conheça os diferentes tipos de elementos em cada nível C4 e como estilizá-los
  • Relacionamentos — Aprenda como criar e estilizar relacionamentos entre elementos de arquitetura

Features

  • Descoberta com IA — Aprenda como o Archyl usa IA para descobrir e documentar automaticamente sua arquitetura a partir do código-fonte — incluindo atualizações incrementais a cada…
  • Solicitações de Mudança de Arquitetura — Proponha, revise e aplique mudanças ao seu modelo C4 de arquitetura através de um fluxo de trabalho estruturado de solicitação de mudanças
  • Documentação e ADRs — Crie e gerencie documentação de arquitetura e Registros de Decisão de Arquitetura no Archyl
  • Anexos da Documentação — Envie imagens e arquivos para as páginas de documentação arrastando e soltando, colando ou pelo botão de anexar — armazenados com segurança em object storage…
  • Fluxos de Usuário — Documente fluxos de usuário e dados pela sua arquitetura para visualizar sequências de interações
  • Arquitetura como Código — Defina e sincronize sua arquitetura C4 com archyl.yaml — versionado, integrado ao CI/CD e totalmente declarativo
  • Time-lapse de Arquitetura — Reproduza o histórico de versões do seu projeto como um filme — os elementos se desenham na tela, serviços removidos são riscados e os créditos sobem — e…
  • Insights de Arquitetura — Detecte automaticamente problemas arquiteturais e receba recomendações para melhorar o design do seu sistema
  • Compartilhamento e Exportação — Compartilhe seus diagramas de arquitetura com stakeholders e exporte em vários formatos
  • Contratos de API — Documente e gerencie especificações de API vinculadas diretamente aos seus elementos de arquitetura C4
  • Gerenciamento de Releases — Rastreie deploys na sua arquitetura com ingestão automatizada via GitHub Actions, webhooks e API REST
  • Integrações do Marketplace — Conecte serviços externos e exiba métricas ao vivo, alertas e dashboards junto à sua arquitetura
  • Realidade de Produção (Diagrama Vivo) — Conecte fontes de produção como Kubernetes, Datadog e New Relic para descobrir serviços e dependências ao vivo, e então reconcilie-os com o seu modelo C4 —…
  • Radar de Tecnologias — Visualize seu panorama tecnológico, acompanhe níveis de adoção e gerencie sua stack tecnológica em todos os projetos
  • Notificações por Webhook — Receba notificações HTTP em tempo real quando mudanças na arquitetura acontecem nos seus projetos
  • Bots do Slack e Teams — Pergunte ao Archyl sobre sua arquitetura pelo Slack ou Microsoft Teams — e deixe-o usar ferramentas MCP ao vivo para responder e agir
  • Mapa de propriedade — Visualize a propriedade de equipes e usuários em sua arquitetura com bolhas interativas, linhas de dependência e acompanhamento de cobertura
  • Regras de Conformidade (Guardrails) — Defina regras de arquitetura determinísticas que validam alterações de código contra seu modelo C4, suas decisões tecnológicas e seus padrões de codificação —…
  • Integração com GitHub Actions — Execute verificações de conformidade arquitetural, cálculo da pontuação de desvio, geração de contexto e muito mais no seu pipeline de CI/CD com as GitHub…
  • Pacotes de Regras de Conformidade — Conjuntos de regras de conformidade prontos para padrões de arquitetura comuns — microsserviços, clean architecture, orientado a eventos, API-first e baseline…
  • Execuções Gerenciadas de Agentes — Despache agentes de IA autônomos que executam em uma programação, conectam-se a serviços externos via conectores MCP e trabalham no seu código com contexto…
  • Use o seu próprio fornecedor de IA — Encaminhe cada funcionalidade de IA do Archyl pelo seu próprio fornecedor (OpenAI, Anthropic, Google Gemini, AWS Bedrock ou qualquer endpoint compatível com…

Guides

  • Criando Seu Primeiro Projeto — Um guia passo a passo para criar e documentar seu primeiro projeto de arquitetura no Archyl
  • Incorporação de Diagramas — Incorpore diagramas interativos do Archyl no Confluence, Notion, Miro e outras plataformas
  • Segurança — Saiba como o Archyl protege seus dados e informações de arquitetura
  • Configurações — Configure provedores de IA, gerencie assinaturas e personalize sua experiência no Archyl
  • Skills para Agentes de Código — Instale e use as 11 skills do Archyl para agentes de código e valide, documente, revise e otimize sua arquitetura diretamente do Claude Code, do Codex ou de…
  • Archyl Harness — Torne qualquer agente de programação consciente da arquitetura em cinco minutos: contexto focado, sessões de trabalho governadas, aplicação de guardrails e uma…

Git integration

Collaboration

Api

  • Visão Geral da API — Conheça a API do Archyl e saiba como integrá-la com suas ferramentas e fluxos de trabalho
  • Autenticação — Aprenda como autenticar com a API do Archyl usando chaves de API
  • Servidor MCP — Conecte assistentes de IA como Claude, Cursor e VS Code à sua arquitetura — 189 ferramentas cobrindo o modelo C4, ADRs, contratos, conformidade, desvio, DORA e…
  • SDKs — Acesso programático à API do Archyl com os SDKs oficiais para Node.js e Python