Mettre à jour le fichier LLMs.txt

Mettre à jour le fichier llms.txt existant à la racine du référentiel pour refléter les changements dans la documentation, les spécifications ou la structure du référentiel. Ce fichier fournit des orientations de haut niveau aux modèles de langage (LLMs) sur où trouver le contenu pertinent pour comprendre le but et les spécifications du référentiel.

Directive principale

Mettre à jour le fichier llms.txt existant pour maintenir la précision et la conformité avec la spécification llms.txt tout en reflétant la structure et le contenu actuels du référentiel. Le fichier doit rester optimisé pour la consommation par des LLMs tout en restant lisible par les humains.

Phase d'analyse et de planification

Avant de mettre à jour le fichier llms.txt, vous devez effectuer une analyse approfondie :

Étape 1 : Examiner le fichier actuel et la spécification

Lire le fichier llms.txt existant pour comprendre la structure actuelle
Consulter la spécification officielle à https://llmstxt.org/ pour assurer la conformité continue
Identifier les zones qui peuvent nécessiter des mises à jour en fonction des changements du référentiel

Étape 2 : Analyse de la structure du référentiel

Examiner la structure actuelle du référentiel à l'aide des outils appropriés
Comparer la structure actuelle avec ce qui est documenté dans le llms.txt existant
Identifier les nouveaux répertoires, fichiers ou documentation qui doivent être inclus
Noter tous les fichiers supprimés ou déplacés qui doivent être mis à jour

Étape 3 : Découverte du contenu et détection des changements

Identifier les nouveaux fichiers README et leurs emplacements
Trouver les nouveaux fichiers de documentation (fichiers .md dans /docs/, /spec/, etc.)
Localiser les nouveaux fichiers de spécification et leurs objectifs
Découvrir les nouveaux fichiers de configuration et leur pertinence
Trouver les nouveaux fichiers d'exemple et exemples de code
Identifier tout changement dans la structure de documentation existante

Étape 4 : Créer un plan de mise à jour

En fonction de votre analyse, créer un plan structuré qui inclut :

Les changements nécessaires pour maintenir la précision
Les nouveaux fichiers à ajouter au llms.txt
Les références obsolètes à supprimer ou mettre à jour
Les améliorations organisationnelles pour maintenir la clarté

Exigences de mise en œuvre

Conformité du format

Le fichier llms.txt mis à jour doit maintenir cette structure exacte selon la spécification :

En-tête H1 : Une seule ligne avec le nom du référentiel/projet (obligatoire)
Résumé entre guillemets : Brève description au format bloc de citation (optionnel mais recommandé)
Détails supplémentaires : Zéro ou plus sections markdown sans en-têtes pour le contexte
Sections de liste de fichiers : Zéro ou plus sections H2 contenant des listes markdown de liens

Exigences de contenu

Éléments obligatoires

Nom du projet : Titre clair et descriptif en H1
Résumé : Bloc de citation concis expliquant l'objectif du référentiel
Fichiers clés : Fichiers essentiels organisés par catégorie (sections H2)

Format de lien de fichier

Chaque lien de fichier doit suivre : [nom-descriptif](url-relative): description optionnelle

Organisation des sections

Organiser les fichiers en sections H2 logiques telles que :

Documentation : Fichiers de documentation core
Spécifications : Spécifications techniques et exigences
Exemples : Exemples de code et d'utilisation
Configuration : Fichiers de configuration et d'installation
Optionnel : Fichiers secondaires (signification spéciale - peuvent être ignorés pour un contexte plus court)

Directives de contenu

Langage et style

Utiliser un langage concis, clair et sans ambiguïté
Éviter le jargon sans explication
Écrire pour les lecteurs humains et les LLMs
Être spécifique et informatif dans les descriptions

Critères de sélection des fichiers

Inclure les fichiers qui :

Expliquent l'objectif et le périmètre du référentiel
Fournissent une documentation technique essentielle
Montrent les exemples d'utilisation et les modèles
Définissent les interfaces et spécifications
Contiennent les instructions de configuration et d'installation

Exclure les fichiers qui :

Sont purement des détails d'implémentation
Contiennent des informations redondantes
Sont des artefacts de build ou du contenu généré
Ne sont pas pertinents pour comprendre le projet

Étapes d'exécution

Étape 1 : Analyse de l'état actuel

Lire le fichier llms.txt existant en détail
Examiner complètement la structure actuelle du référentiel
Comparer les références de fichiers existantes avec le contenu réel du référentiel
Identifier les références obsolètes, manquantes ou incorrectes
Noter tout problème structurel avec le fichier actuel

Étape 2 : Planification du contenu

Déterminer si la déclaration d'objectif principal nécessite des mises à jour
Examiner et mettre à jour le bloc de citation de résumé si nécessaire
Planifier les ajouts pour les nouveaux fichiers et répertoires
Planifier les suppressions du contenu obsolète ou déplacé
Réorganiser les sections si nécessaire pour une meilleure clarté

Étape 3 : Mises à jour de fichiers

Mettre à jour le fichier llms.txt existant à la racine du référentiel
Maintenir la conformité avec la spécification de format exacte
Ajouter de nouvelles références de fichiers avec des descriptions appropriées
Supprimer ou mettre à jour les références obsolètes
Assurer que tous les liens sont des chemins relatifs valides

Étape 4 : Validation

Vérifier la conformité continue avec la spécification https://llmstxt.org/
Vérifier que tous les liens sont valides et accessibles
S'assurer que le fichier sert toujours de bon outil de navigation pour LLMs
Confirmer que le fichier reste lisible par les humains et les machines

Assurance qualité

Validation du format

✅ En-tête H1 avec le nom du projet
✅ Bloc de citation de résumé (si inclus)
✅ Sections H2 pour les listes de fichiers
✅ Format correct des liens markdown
✅ Aucun lien cassé ou invalide
✅ Formatage cohérent throughout

Validation du contenu

✅ Langage clair et sans ambiguïté
✅ Couverture complète des fichiers essentiels
✅ Organisation logique du contenu
✅ Descriptions de fichiers appropriées
✅ Sert d'outil de navigation efficace pour les LLMs

Conformité avec la spécification

✅ Suit exactement le format https://llmstxt.org/
✅ Utilise la structure markdown requise
✅ Implémente les sections optionnelles de manière appropriée
✅ Fichier situé à la racine du référentiel (/llms.txt)

Stratégie de mise à jour

Processus d'ajout

Lors de l'ajout de nouveau contenu :

Identifier la section appropriée pour les nouveaux fichiers
Créer des noms clairs et descriptifs pour les liens
Écrire des descriptions concises mais informatives
Maintenir un tri alphabétique ou logique dans les sections
Considérer si de nouvelles sections sont nécessaires pour les nouveaux types de contenu

Processus de suppression

Lors de la suppression de contenu obsolète :

Vérifier que les fichiers sont réellement supprimés ou déplacés
Vérifier si les fichiers déplacés doivent être mis à jour plutôt que supprimés
Supprimer les sections entières si elles deviennent vides
Mettre à jour les références croisées si nécessaire

Processus de réorganisation

Lors de la restructuration du contenu :

Maintenir un flux logique du général au spécifique
Garder la documentation essentielle dans les sections principales
Déplacer le contenu secondaire vers la section « Optionnel » si approprié
S'assurer que la nouvelle organisation améliore la navigation pour les LLMs

Exemple de structure pour llms.txt :

# [Nom du référentiel]

> [Description concise de l'objectif et du périmètre du référentiel]

[Paragraphes de contexte optionnels sans en-têtes]

## Documentation

- [README principal](README.md): Documentation principale du projet et guide de démarrage
- [Guide de contribution](CONTRIBUTING.md): Directives pour contribuer au projet
- [Code de conduite](CODE_OF_CONDUCT.md): Directives de la communauté et attentes

## Spécifications

- [Spécification technique](spec/technical-spec.md): Exigences techniques détaillées et contraintes
- [Spécification API](spec/api-spec.md): Définitions d'interface et contrats de données

## Exemples

- [Exemple basique](examples/basic-usage.md): Démonstration simple d'utilisation
- [Exemple avancé](examples/advanced-usage.md): Modèles d'implémentation complexes

## Configuration

- [Guide d'installation](docs/setup.md): Instructions d'installation et de configuration
- [Guide de déploiement](docs/deployment.md): Directives de déploiement en production

## Optionnel

- [Documentation d'architecture](docs/architecture.md): Architecture système détaillée
- [Décisions de conception](docs/decisions.md): Enregistrements historiques des décisions de conception

Critères de succès

Le fichier llms.txt mis à jour devrait :

Refléter avec précision la structure et le contenu actuels du référentiel
Maintenir la conformité avec la spécification llms.txt
Fournir une navigation claire vers la documentation essentielle
Supprimer les références obsolètes ou incorrectes
Inclure les nouveaux fichiers et documentation importants
Maintenir une organisation logique pour une consommation facile par les LLMs
Utiliser un langage clair et sans ambiguïté
Continuer à servir efficacement les lecteurs humains et les machines

update-llms