Générateur de document d'architecture

VérifiéSûr

Génère un PDF concis d'architecture système avec diagrammes intégrés, basé sur l'analyse du code.

Spar Skills Guide Bot
DocumentationIntermédiaire
22/07/2026
Claude Code
#architecture-docs#pdf-generation#diagrams#weasyprint#technical-writing

Recommandé pour

Synthèse automatique

Génère docs/architecture.pdf, un document de 5 à 8 pages intégrant les trois diagrammes SVG de la skill diagrams pour décrire l'architecture, le flux d'exécution, les dépendances et l'environnement d'exploitation.

Points forts

  • Impose de régénérer les diagrammes si le code a changé, afin que les visuels correspondent au système décrit
  • Décrit une chaîne de rendu concrète : rastérisation cairosvg à scale=1.4, HTML autonome, WeasyPrint, puis vérification visuelle via ghostscript
  • Structure de sections fixe (vue d'ensemble, Temporal, flux, infrastructure, dépendances, exploitation) qui évite les docs fourre-tout
  • Style et palette imposés pour rester cohérent avec le modèle output-template.html

Limites

  • Suppose une stack précise (Temporal, Azure, helm, WORKER_QUEUES) héritée de la skill diagrams ; peu réutilisable tel quel sur un autre type de projet
  • Dépend d'outils externes à installer : cairosvg, WeasyPrint et ghostscript
  • La vérification se limite à 2-3 pages rastérisées ; les erreurs de contenu sur les autres pages ne sont pas détectées
Quand l'utiliser

À utiliser quand il faut produire un PDF d'architecture ou de conception à jour, illustré et prêt à partager pour un projet de type Temporal/Azure.

Quand l'éviter

À éviter si le projet n'utilise pas les diagrammes de la skill diagrams ou s'il faut un document Markdown, un site de docs ou un format autre que PDF.

Analyse de sécurité

Sûr
Score qualité80/100

The skill is a local documentation pipeline: it reads source files, rasterizes existing SVGs, renders HTML to PDF, and inspects output pages. Nothing is exfiltrated, obfuscated, or destructive, and no safety controls are disabled. The only mild consideration is that it shells out to build/render binaries and touches many project files (including example env/helm configs), but that is ordinary, legitimate tooling use.

Points d'attention
  • •Invokes external CLI tooling (cairosvg, WeasyPrint, ghostscript, make targets, test.sh/admin.sh) but all operations are local read/render/write within the project — no network calls or data egress.
  • •Reads a broad set of project files including .env.example and helm values; the instructions reference a 'secrets model' but only point at example/config files, not live secrets. Worth confirming it never ingests real .env or secrets.yaml contents into the PDF.
  • •Hard dependency on a sibling `diagrams` skill and `output-template.html` means it executes code/instructions it does not itself define.
  • •Writes into docs/ (architecture.pdf, scratchpad artifacts); non-destructive, no deletion or overwrite of source files.
Comment cette analyse est faite

Exemples

Full architecture PDF
Generate an architecture document for this repo: refresh the diagrams if the workflow or worker files changed, then produce docs/architecture.pdf.
Design doc from code
I need a system overview PDF covering our Temporal queues, execution flow and cloud infrastructure — read the code first, don't guess.
Refresh after changes
We changed worker.py and the helm values, so the diagrams are stale. Regenerate them and rebuild docs/architecture.pdf with updated dependencies and ops sections.

name: archdoc description: Generate docs/architecture.pdf — a concise document covering the architecture, workflow, dependencies, and operational environment, embedding the SVGs produced by the diagrams skill. Use when the user asks for an architecture document, design doc, or system overview PDF.

Architecture document generator

Produce docs/architecture.pdf: concise (target 5-8 A4 pages), current, and visual. The three diagrams from the diagrams skill are the backbone; the prose fills in what pictures can't say. Never describe architecture from memory — read the code first.

Process

  1. Freshen the diagrams. If docs/diagrams/temporal.svg, infra.svg, or flow.svg are missing — or the workflow/worker/chart files changed since they were generated — run the diagrams skill first. This document must embed diagrams that match the code it describes.
  2. Gather facts from the same sources of truth the diagrams skill lists (workflows.py, activities.py, worker.py, shared.py, helm values, .env.example, Makefile), plus requirements.txt, requirements-dev.txt, VERSION, and tests/.
  3. Rasterize the diagrams for embedding with cairosvg at print sharpness (scale=1.4) into the session scratchpad — not ImageMagick (it drops SVG features). Embed the PNGs, not the SVGs (WeasyPrint's own SVG support is partial).
  4. Author one self-contained HTML in the scratchpad. Sections, in order:
    • Overview: what the system does, one paragraph + the artifact outputs.
    • Temporal architecture: embed temporal.png; prose on queues/pools/caps and why (per-resource quota protection), worker roles via WORKER_QUEUES.
    • Execution flow: embed flow.png; prose on ordering, parallelism, retry/heartbeat/resume behavior, fail-fast validations.
    • Cloud infrastructure: embed infra.png; prose on the resource group contents, images, public/private storage split.
    • Dependencies: Azure services table + Python packages (runtime and dev).
    • Operational environment: endpoints (Temporal frontend DNS, UI via admin.sh), config/secrets model (.env locally, helm secrets.yaml to Kubernetes Secrets, runtime listKeys, API-key gate), scaling knobs (replicas x per-pod caps), and the day-to-day commands (make targets, test.sh, admin.sh, local worker/start). Style: match output-template.html's look (same palette #16324f/#2a6fb0, Helvetica, A4 @page with page numbers). Full-width images, each with a short caption. Keep prose tight — bullets over paragraphs.
  5. Render with WeasyPrint to docs/architecture.pdf. Include the project VERSION and generation date on the title header.
  6. Verify: the file starts with %PDF; rasterize 2-3 pages with ghostscript (gs -sDEVICE=png16m) and visually inspect for overflowing text, blank/missing images, or awkward page breaks. Fix and re-render before finishing.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/architecture-document-generator-mrwak9zg' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/architecture-document-generator-mrwak9zg/download' --output '.skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md.part' && mv '.skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md.part' '.skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md' && test -s '.skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/archdoc' && cp -R '.skill-downloads/architecture-document-generator-mrwak9zg' '.claude/skills/archdoc'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/architecture-document-generator-mrwak9zg'

openskills read 'architecture-document-generator-mrwak9zg'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/architecture-document-generator-mrwak9zg/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires