Skills Guide

Essai à sec du pipeline de documentation

VérifiéPrudence

Exécute les phases de diff et de planification du pipeline de documentation hebdomadaire en mode lecture seule. Rapporte ce qu'un run complet ferait sans écrire dans src/ ni avancer state.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationAvancé
23/07/2026
Claude Code
#docs-pipeline#dry-run#diff-analysis#read-only#planning

Recommandé pour

Claude CodeDocumentation automatique

Synthèse automatique

Exécute en lecture seule les phases 0 et 1 du pipeline de documentation hebdomadaire : clone les dépôts produits, calcule les diffs depuis le dernier commit traité, planifie les tâches de documentation et produit un rapport sans rien modifier.

Points forts

  • Garantit l'absence d'effet de bord : aucune écriture sous src/, aucun commit, state.json jamais avancé
  • Produit des artefacts JSON inspectables (diff.json, plan.json) dans un répertoire de run daté et gitignoré
  • Inclut des validateurs en lecture seule (sidebar, liens) avec résumés par type
  • Donne une prévisualisation complète de ce qu'un run /docs-weekly ferait réellement

Limites

  • Dépend de fichiers d'orchestration internes (workflows docs-diff.js, repos.json, state.json) propres à ce dépôt
  • Les signaux analytiques ne sont pas encore disponibles (M4), ce qui limite la pertinence de la priorisation
  • Ne couvre que les phases 0 et 1 : ni rédaction, ni captures d'écran, ni validation complète
Quand l'utiliser

À utiliser pour vérifier et prévisualiser l'impact d'un prochain run de documentation hebdomadaire avant de lancer le pipeline complet.

Quand l'éviter

Ne pas l'utiliser pour rédiger ou publier réellement de la documentation, puisque le skill est strictement en lecture seule et n'avance pas l'état.

Analyse de sécurité

Prudence
Score qualité85/100

The skill uses network, filesystem, agent spawning, and local script execution, which are powerful capabilities, but its instructions are explicitly read-only toward source and state files and prohibit commits/pushes. No destructive, exfiltrating, or obfuscated behavior is present.

Points d'attention
  • •Clones three product repositories over the network into a temp workspace.
  • •Executes local Node scripts (`validate-sidebar.js`, `check-links.js`) whose contents are not included.
  • •Spawns an agent and passes it the full diff contents.
  • •Deletes `RUN_DIR/sources/` during cleanup.
  • •No allowed-tools are declared, so effective tool permissions are unclear.
Comment cette analyse est faite

Exemples

Preview weekly docs impact
Do a dry run of the docs pipeline for today: diff the three product repos since the last processed commit and show me the planned work items.
Check docs health before a full run
Run docs-dry-run and report per-repo user-facing changes plus the current sidebar and link validator counts.
Inspect planned screenshots
Dry-run the docs pipeline and list the screenshot requests the plan generated, along with the deferred items.

name: docs-dry-run description: Phases 0+1 of the docs pipeline, read-only. Clones the three product repos into a temp workspace, diffs them since the last processed commit, plans the documentation work items, and reports. Writes nothing under src/ and never advances state.json.

Docs pipeline dry run (Phases 0+1, read-only)

Run the diff and planning phases of the weekly docs pipeline and report what a full run WOULD do. Hard rules for this skill:

  • Never edit anything under src/, automation/state.json, or automation/*-baseline.json.
  • Never commit, push, branch, or open a PR.
  • Write only under automation/runs/<date>/ (gitignored).

Steps

  1. Prepare. Let DATE = today as YYYY-MM-DD, RUN_DIR = automation/runs/<DATE>. Create RUN_DIR. Read automation/state.json and automation/repos.json.

  2. Phase 0, diff. Invoke the Workflow tool with scriptPath: ".claude/workflows/docs-diff.js" (by path, not by name, see DESIGN.md 5.2.1) and:

    args: {
  date: <DATE>,
  runDir: "automation/runs/<DATE>",
  repos: [
    { key, product, url, lastSha: state.lastSha[key], docsTargets, productMapPath: "automation/product-map.json" only for teamspro }
    ... one entry per repo in repos.json
  ]
}

    Save the returned object to RUN_DIR/diff.json.

  3. Phase 1, plan. Spawn one doc-gap-analyst agent. Give it: the full contents of RUN_DIR/diff.json, the writer cap (12), and note that analytics signals are not yet available (M4). Ask for the structured work plan (workItems, deferred, attention, stats). Save it to RUN_DIR/plan.json.

  4. Validators (read-only). Run node automation/scripts/validate-sidebar.js --json and node automation/scripts/check-links.js --json and capture their summaries (counts by type, do not paste hundreds of findings).

  5. Report. Print a readable summary for the user:

    • Per repo: commits analyzed (diff range), user-facing changes found, anything in attention (unmapped modules, suite-wide changes), fallback windows or clone errors.
    • The ranked work items: id, action, product, pages, priority, one-line rationale. Then the deferred list.
    • Screenshot requests the plan generated (they would be captured in Phase 3).
    • Current docs health from the validators (counts only).
    • Close with: what a full /docs-weekly run would now do (write, screenshot, validate, open PR) and that state.json was NOT advanced.

  6. Cleanup. Delete RUN_DIR/sources/ (the temp clones). Keep the JSON artifacts for inspection.

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/docs-pipeline-dry-run-mrx3xwgg/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/docs-pipeline-dry-run-mrx3xwgg' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/docs-pipeline-dry-run-mrx3xwgg/download' --output '.skill-downloads/docs-pipeline-dry-run-mrx3xwgg/SKILL.md.part' && mv '.skill-downloads/docs-pipeline-dry-run-mrx3xwgg/SKILL.md.part' '.skill-downloads/docs-pipeline-dry-run-mrx3xwgg/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/docs-pipeline-dry-run-mrx3xwgg/SKILL.md' && test -s '.skill-downloads/docs-pipeline-dry-run-mrx3xwgg/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs-dry-run' && cp -R '.skill-downloads/docs-pipeline-dry-run-mrx3xwgg' '.claude/skills/docs-dry-run'

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/docs-pipeline-dry-run-mrx3xwgg'

openskills read 'docs-pipeline-dry-run-mrx3xwgg'

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/docs-pipeline-dry-run-mrx3xwgg/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

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot