1Exemples: choose a starter example or paste your own source.
2Review the generated preview and adjust labels, conditions, or configuration details.
3Copy the source or export the rendered result when it is ready for documentation.

Cas d’usage

README and engineering design docsArchitecture reviews and API documentationAI-generated diagram validation before publishing

Outils associés

Générateur de diagrammes IA

Générateur de diagrammes IA pour prévisualisation, review et export dans la documentation développeur.

Correcteur Mermaid IA

Correcteur Mermaid IA pour prévisualisation, review et export dans la documentation développeur.

Architecture Diagram Generator

Generate Mermaid architecture diagrams from product or system notes with AI.

FAQ

Puis-je l’utiliser avec du contenu généré par IA ?

Oui. Utilisez l’IA pour le premier brouillon, puis prévisualisez et ajustez avant publication.

Utilisez cet outil pour la documentation développeur, les notes d’architecture, les runbooks, les spécifications API et les diagrammes générés par IA.

Commencez avec un exemple, remplacez-le par votre source et gardez la sortie avec le texte original pour la revue.

Pour la documentation de production, exportez en SVG ou PNG si possible et conservez la source dans le dépôt.

Demo: generate an observability starter pack

An observability pack is strongest when dashboard panels, alert rules, architecture context, and runbook steps are generated together for the same service.

Include service name, runtime, dependencies, and SLO target in the prompt.
Generate dashboards and alerts from the same metric vocabulary.
Review runbook actions before using the pack for on-call work.

Service: checkout-api
Runtime: Kubernetes
Metrics: Prometheus http_requests_total, duration buckets
Logs: Loki by service label
SLO: 99.9% successful checkout requests

Operations checklist: generated observability needs tuning

Generated dashboards and alerts should be imported into a test folder first. Metric labels, datasource UIDs, severities, and thresholds must match your environment.

Replace placeholder datasource IDs.
Tune alert thresholds with historical data.
Add owner, escalation, and runbook links before paging.

dashboard folder: draft
alert severity: ticket -> page after validation
runbook: /runbooks/checkout-api

Checklist de revue pour Générateur de pack d’observabilité

Utilisez Générateur de pack d’observabilité pour inspecter visuellement une source avant documentation, note de PR, post-mortem ou transfert. Générateur de pack d’observabilité: Generate Grafana dashboard YAML, Prometheus rules, Mermaid architecture, and a runbook checklist with AI.

Avant export, vérifiez la lisibilité, les relations, les données sensibles et la cohérence après modification.

Limites et dépannage

Si l'aperçu échoue, réduisez l'entrée au plus petit exemple complet, validez la syntaxe puis réajoutez les sections.

Considérez l'aperçu comme une surface de revue, pas comme une source de vérité. Les résultats critiques doivent être validés.

Exemples à tester

API service: Generate an observability pack for a checkout API with p95 latency, error rate, saturation, Redis dependency, and payment provider failures.
Kubernetes app: Create an observability pack for a Kubernetes web app with ingress, deployment replicas, pod restarts, CPU, memory, logs, and SLO burn alerts.
Queue worker: Generate dashboards and alerts for an order worker that consumes Kafka, writes PostgreSQL, and must monitor lag, retries, dead letters, and processing time.

Maturité de l'outil

AI beta

Beta assistée par AI

Cet outil génère une source modifiable avec AI. Relisez, prévisualisez localement et ajustez avant publication.

Le libellé indique si l'outil convient surtout à l'export stable, au débogage, à l'analyse rapide ou à la génération AI.