Documentazione

Impara a usare Archyl.

Getting started

  • Introduzione ad Archyl — Scopri cos'è Archyl e come ti aiuta a documentare la tua architettura software usando il modello C4
  • Guida Rapida — Inizia con Archyl in 5 minuti - crea il tuo primo diagramma di architettura
  • Concetti Fondamentali — Comprendi i concetti chiave e la terminologia usati in Archyl

C4 model

  • Panoramica del Modello C4 — Scopri il modello C4 e come Archyl lo implementa per la documentazione architetturale
  • Elementi e Stili — Scopri i diversi tipi di elemento a ogni livello C4 e come personalizzarne lo stile
  • Relazioni — Scopri come creare e personalizzare le relazioni tra gli elementi architetturali

Features

  • Scoperta potenziata dall'IA — Scopri come Archyl utilizza l'IA per scoprire e documentare automaticamente la tua architettura dal codebase, con aggiornamenti incrementali a ogni push
  • Richieste di Modifica Architetturale — Proponi, revisiona e applica modifiche al tuo modello architetturale C4 attraverso un workflow strutturato di richiesta di modifica
  • Documentazione e ADR — Crea e gestisci documentazione architetturale e Architecture Decision Record in Archyl
  • Allegati della documentazione — Carica immagini e file nelle pagine di documentazione trascinandoli, incollandoli o con il pulsante Allega, archiviati in modo sicuro in un object storage…
  • Flussi Utente — Documenta i flussi utente e dati attraverso la tua architettura per visualizzare sequenze di interazioni
  • Architettura come Codice — Definisci e sincronizza la tua architettura C4 con archyl.yaml — versionato, integrato con CI/CD e completamente dichiarativo
  • Time-lapse dell'architettura — Riproduci la cronologia delle versioni del tuo progetto come un film — gli elementi si disegnano da soli, i servizi ritirati vengono barrati e scorrono i…
  • Insight Architetturali — Rileva automaticamente problemi architetturali e ottieni raccomandazioni per migliorare il design del tuo sistema
  • Condivisione ed Esportazione — Condividi i tuoi diagrammi architetturali con gli stakeholder ed esportali in vari formati
  • Contratti API — Documenta e gestisci le specifiche API collegate direttamente ai tuoi elementi architetturali C4
  • Gestione delle Release — Traccia i deploy attraverso la tua architettura con ingestione automatizzata da GitHub Actions, webhook e API REST
  • Integrazioni Marketplace — Collega servizi esterni e visualizza metriche live, alert e dashboard accanto alla tua architettura
  • Realtà di produzione (Diagramma vivente) — Collega fonti di produzione come Kubernetes, Datadog e New Relic per scoprire servizi e dipendenze live, poi riconciliali con il tuo modello C4 — sola lettura…
  • Technology Radar — Visualizza il panorama tecnologico, monitora i livelli di adozione e gestisci il tuo stack tecnologico in tutti i progetti
  • Notifiche Webhook — Ricevi notifiche HTTP in tempo reale quando avvengono modifiche all'architettura nei tuoi progetti
  • Bot Slack e Teams — Chiedi ad Archyl informazioni sulla tua architettura da Slack o Microsoft Teams — e lascia che usi gli strumenti MCP dal vivo per rispondere e agire
  • Mappa di proprietà — Visualizza la proprietà di team e utenti nell'architettura con bolle interattive, linee di dipendenza e monitoraggio della copertura
  • Regole di conformità (guardrail) — Definisci regole architetturali deterministiche che validano le modifiche al codice rispetto al tuo modello C4, alle decisioni tecnologiche e agli standard di…
  • Integrazione GitHub Actions — Esegui controlli di conformità architetturale, calcolo del punteggio di drift, generazione del contesto e altro nella tua pipeline CI/CD con le GitHub Actions…
  • Pacchetti di regole di conformità — Set di regole di conformità pronti all'uso per i pattern architetturali più comuni: microservizi, clean architecture, event-driven, API-first e baseline di…
  • Esecuzioni gestite degli agenti — Avvia agenti AI autonomi che vengono eseguiti su base pianificata, si connettono a servizi esterni tramite connettori MCP e lavorano sul tuo codebase con il…
  • Porta il tuo provider di IA — Instrada ogni funzione IA di Archyl tramite il tuo provider (OpenAI, Anthropic, Google Gemini, AWS Bedrock, o qualsiasi endpoint compatibile OpenAI) con le tue…
  • Palette dei comandi — Premi Cmd+K per cercare nella tua architettura ed eseguire azioni da un unico campo: aprire qualsiasi pagina, creare una decisione o un documento, avviare una…

Guides

  • Creare il Tuo Primo Progetto — Una guida passo passo per creare e documentare il tuo primo progetto di architettura in Archyl
  • Incorporare Diagrammi — Incorpora diagrammi interattivi di Archyl in Confluence, Notion, Miro e altre piattaforme
  • Sicurezza — Scopri come Archyl protegge i tuoi dati e le informazioni architetturali
  • Impostazioni e Configurazione — Configura i provider IA, gestisci gli abbonamenti e personalizza la tua esperienza con Archyl
  • Skill per agenti di programmazione — Installa e usa le 11 skill per agenti di programmazione di Archyl per validare, documentare, revisionare e ottimizzare la tua architettura direttamente da…
  • Archyl Harness — Rendi qualsiasi agente di programmazione consapevole dell'architettura in cinque minuti: contesto mirato, sessioni di lavoro governate, applicazione dei…

Git integration

Collaboration

  • Gestione dei Team — Scopri come creare e gestire i team in Archyl per una migliore collaborazione
  • Lavagna Collaborativa in Tempo Reale — Collabora sui diagrammi architetturali in tempo reale con il tuo team
  • Riepilogo dell'architettura del team — Invia a ogni team un riepilogo email periodico dell'attività architetturale — drift, ADR, conformità, discussioni.
  • Notifiche — Come Archyl ti segnala ciò che richiede la tua attenzione: la inbox nell'app per ciò che aspetta te e le notifiche email, da attivare, per le modifiche…
  • Registro Attività — Vedi ogni modifica fatta nella tua organizzazione, apri l'elemento a cui si riferisce e leggi cosa è cambiato campo per campo, dalla pagina Cronologia o dal…
  • Menzioni, citazioni e link — Nomina le persone con @, cita elementi, decisioni e pagine con #, scopri dove qualcosa è citato e condividi link che si aprono come anteprima in Archyl e in…
  • Seguire — Segui un elemento, una decisione o un progetto per ricevere modifiche, commenti e richieste di modifica nella tua inbox.
  • Attività — Trasforma un commento in un'attività con un assegnatario, una scadenza facoltativa e una casella di spunta, e ritrova le tue attività nella inbox e su ogni…
  • Commenti sul diagramma — Fissa una discussione ovunque sul diagramma: su uno spazio vuoto, un elemento o una relazione, al livello che stai guardando.

Api

  • Panoramica API — Scopri l'API di Archyl e come integrarla con i tuoi strumenti e flussi di lavoro
  • Autenticazione — Scopri come autenticarti con l'API di Archyl utilizzando le chiavi API
  • Server MCP — Collega assistenti AI come Claude, Cursor e VS Code alla tua architettura — 191 strumenti che coprono il modello C4, ADR, contratti, conformità, drift, DORA e…
  • SDK — Accesso programmatico all'API di Archyl con gli SDK ufficiali per Node.js e Python