Générer le catalogue de projet

VérifiéPrudence

Génère ou met à jour CATALOG.md à partir des métadonnées des tickets déployés. Crée un catalogue d'actifs complet avec instructions d'utilisation.

Spar Skills Guide Bot
DocumentationIntermédiaire
28/07/2026
Claude CodeCodex
#catalog-generation#asset-inventory#markdown#ticket-metadata#changelog

Recommandé pour

Synthèse automatique

Ce skill génère ou met à jour un fichier CATALOG.md en scannant les tickets déployés au format JSON, en extrayant les métadonnées files_created et en regroupant les fichiers par catégorie avec leurs instructions d'utilisation.

Points forts

  • Automatise la tenue du catalogue à partir des tickets existants plutôt que d'un inventaire manuel
  • Classe les fichiers par motifs de chemin (components, styles, utils, data, pages, tests) et produit un tableau récapitulatif avec compteurs
  • Conserve la traçabilité en indiquant le ticket créateur de chaque fichier et en alimentant un changelog daté
  • Renvoie un résultat JSON structuré (statut, statistiques, erreurs) exploitable par un pipeline

Limites

  • Suppose un format de ticket précis (tableau files_created avec path/type/intended_use) et l'outil jq ; un ticket non conforme fait échouer le parsing
  • La table de catégories est codée en dur sur une arborescence de type src/**, ce qui demande une adaptation pour une autre structure de projet
  • Le comportement de fusion avec un CATALOG.md existant n'est décrit que partiellement dans le skill
Quand l'utiliser

À utiliser lorsqu'un projet suit déjà son travail sous forme de tickets JSON déployés et qu'il faut maintenir un catalogue d'actifs à jour sans bookkeeping manuel.

Quand l'éviter

À éviter sur un projet sans ce format de tickets ou lorsqu'on attend une documentation plus riche qu'un simple tableau Markdown généré.

Analyse de sécurité

Prudence
Score qualité82/100

The skill is not destructive or exfiltrating; it reads local ticket JSON and writes a catalog file. However, it relies on shell/jq execution and filesystem writes despite declaring no allowed tools, so it warrants caution rather than a fully safe rating.

Points d'attention
  • •Declares no allowed-tools but instructs use of bash, jq, and direct filesystem writes.
  • •Uses unquoted `$tickets_dir` in `cd $tickets_dir` and the `*.json` loop, which can break on paths with spaces or glob characters.
  • •Writes CATALOG.md directly into the project filesystem without validation or dry-run safeguards.
Comment cette analyse est faite

Exemples

Generate from current sprint
Generate CATALOG.md for /projects/oxygen_site using the deployed tickets in tickets/sprint_current/deployed, excluding test files.
Include tests and report counts
Regenerate the asset catalog for this project with include_tests set to true, then tell me how many files landed in each category.
Update from archived sprint
Merge the files from the tickets in tickets/archive/sprint-42 into the existing CATALOG.md and add a changelog entry for today.

name: generate-catalog description: Generate CATALOG.md from deployed tickets. Extracts files_created metadata and builds project asset catalog with usage instructions.

generate-catalog - Project Catalog Generator

Generates or updates CATALOG.md from deployed ticket metadata. Builds a comprehensive asset catalog showing all components, styles, and utilities with usage instructions.

Input Schema

{
  "project_dir": "/path/to/project",
  "tickets_dir": "/path/to/tickets/deployed",
  "include_tests": false,
  "include_deps": true
}

Instructions

1. Scan Deployed Tickets

cd $tickets_dir
for ticket in *.json; do
    jq -r '.files_created[]' "$ticket"
done

2. Extract File Metadata

For each deployed ticket, extract:

{
  "files_created": [
    {
      "path": "src/components/MetricCard.js",
      "type": "component",
      "intended_use": "Import { MetricCard } from './MetricCard.js'"
    }
  ]
}

3. Categorize Assets

| Category | Patterns | Description | |----------|----------|-------------| | Components | src/components/**/*.js | Reusable UI components | | Styles | src/styles/**/*.css | CSS stylesheets | | Utils | src/utils/**/*.js, src/js/utils/** | Helper functions | | Data | src/data/**/*.json | Static data files | | Pages | src/pages/**/*.html | HTML pages | | Tests | tests/**/*, *.spec.js | Test files (if included) |

4. Generate Markdown

# Project Asset Catalog

> Auto-generated by generate-catalog on {date}

## Summary

| Category | Count | Status |
|----------|-------|--------|
| Components | 5 | ✅ |
| Styles | 3 | ✅ |

## Components

| File | Intended Use | Created By |
|------|--------------|------------|
| `src/components/MetricCard.js` | Import { MetricCard } | TICKET-001 |

Output Format

{
  "skill": "generate-catalog",
  "status": "success|failure",
  "catalog_path": "src/CATALOG.md",
  "stats": {
    "tickets_processed": 5,
    "files_cataloged": 23,
    "categories": {
      "components": 8,
      "styles": 5,
      "utils": 4,
      "data": 2,
      "pages": 4
    }
  },
  "errors": [],
  "warnings": [],
  "next_action": "proceed"
}

Catalog Structure

# Project Asset Catalog

> Auto-generated by generate-catalog on 2026-01-07

## Summary

| Category | Count | Status |
|----------|-------|--------|
| Components | 8 | ✅ |
| Styles | 5 | ✅ |
| Utils | 4 | ✅ |
| Data | 2 | ✅ |
| **Total** | **19** | |

## Components

| File | Intended Use | Created By |
|------|--------------|------------|
| `src/components/impact/MetricCard.js` | Import { MetricCard } from './MetricCard.js' | TICKET-OXY-003-A.3 |

## Styles

| File | Intended Use | Created By |
|------|--------------|------------|
| `src/styles/components/metric-card.css` | Link in HTML: <link rel="stylesheet" href="..."> | TICKET-OXY-003-A.3 |

## Changelog

- **2026-01-07**: Added MetricCard component via TICKET-OXY-003-A.3

Decision Logic

All tickets parsed successfully?
    YES → status: "success"
    NO  → status: "failure", errors: [parse errors]

Catalog written successfully?
    YES → next_action: "proceed"
    NO  → next_action: "fix"

Usage Examples

Generate from deployed tickets:

{
  "project_dir": "/projects/oxygen_site",
  "tickets_dir": "/projects/oxygen_site/tickets/sprint_current/deployed",
  "include_tests": false,
  "include_deps": true
}

Include test files:

{
  "project_dir": "/projects/oxygen_site",
  "tickets_dir": "/projects/oxygen_site/tickets/sprint_current/deployed",
  "include_tests": true,
  "include_deps": true
}

Custom tickets directory:

{
  "project_dir": "/projects/oxygen_site",
  "tickets_dir": "/projects/oxygen_site/tickets/archive/sprint-42",
  "include_tests": false,
  "include_deps": false
}

Merge Behavior

When updating existing CATALOG.md:

  1. Read existing catalog
  2. Add new files from recently deployed tickets
  3. Preserve existing entries (don't remove)
  4. Update changelog section
  5. Sort entries alphabetically within categories

Token Efficiency

  • JSON parsing only, no LLM inference
  • Incremental updates (append-only)
  • ~2-5 second execution
  • Writes directly to file system

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

Codex
test -f '.skill-downloads/generate-project-catalog-ms47vq35/SKILL.md' && test -s '.skill-downloads/generate-project-catalog-ms47vq35/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/generate-catalog' && cp -R '.skill-downloads/generate-project-catalog-ms47vq35' '.agents/skills/generate-catalog'

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/generate-project-catalog-ms47vq35'

openskills read 'generate-project-catalog-ms47vq35'

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/generate-project-catalog-ms47vq35/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