llm-doc-writer
Créer une documentation LLM efficace en tokens
La documentation longue gaspille le contexte et ralentit le travail assisté par IA. Cette compétence transforme les connaissances projet en tableaux concis, puces, exemples et structure prête pour les agents.
Télécharger le ZIP de la compétence
Importer dans Claude
Accédez à Paramètres → Capacités → Skills → Importer une compétence
Activez et commencez à utiliser
Ressources lisibles par les agents
Utilisez ces liens lorsqu’un Agent IA, un crawler ou un script a besoin d’un contexte propre au lieu de lire toute la page.
Tester
Utilisation de « llm-doc-writer ». Un long README avec des instructions de configuration, des détails de stack et une prose d'architecture.
Résultat attendu:
Un README plus court avec un tableau de stack, des étapes de configuration numérotées, une référence des commandes et des puces d'architecture.
Utilisation de « llm-doc-writer ». Un projet sans guide d'agent pour Claude, Codex ou Claude Code.
Résultat attendu:
Un guide d'agent compact avec commandes, conventions, notes d'architecture et liens vers des fichiers détaillés.
Utilisation de « llm-doc-writer ». Une section API rédigée sous forme de paragraphes.
Résultat attendu:
Un résumé d'endpoints facile à parcourir avec les champs requis, les réponses attendues et des notes d'utilisation concises.
Audit de sécurité
SûrStatic analysis reported external command, network, weak crypto, and reconnaissance patterns. Manual review found only markdown examples, inline code formatting, and ordinary documentation text, with no executable code or malicious intent.
Confirmed security concerns (4)
Score de qualité
Ce que vous pouvez créer
Préparer le contexte d'agent
Créer un fichier CLAUDE.md concis ou un fichier d'instructions d'agent pour une base de code existante.
Compresser la documentation technique
Réécrire de longues sections de configuration, d'architecture ou d'API en documentation facile à parcourir.
Standardiser les README de projet
Construire des sections README cohérentes pour la stack, les commandes, les conventions et les références.
Essayez ces prompts
Crée un CLAUDE.md pour ce projet. Inclus la stack, les commandes, l'architecture, les conventions et des liens vers les fichiers de détails.
Réécris cette documentation pour le contexte LLM. Utilise des tableaux, des puces et des exemples. Supprime le remplissage et les énoncés redondants.
Examine ce long document projet. Propose une documentation d'agent principale ainsi que des fichiers ciblés pour l'architecture, l'API et les workflows.
Audite cette documentation pour son efficacité en tokens. Identifie les sections verbeuses, les commandes manquantes, les conventions peu claires et le contenu à diviser.
Bonnes pratiques
- Fournir les faits sources avant de demander à la compétence de rédiger la documentation finale.
- Garder le document d'agent principal court et ajouter des liens vers des fichiers de détails ciblés.
- Vérifier les commandes générées et les notes d'architecture par rapport au dépôt réel.
Éviter
- Ne pas utiliser la compétence pour inventer des détails projet manquants.
- Ne pas conserver de longs paragraphes narratifs lorsqu'un tableau ou une liste est plus clair.
- Ne pas placer chaque détail du projet dans un seul fichier de contexte d'agent.