Compétences readme
📦

readme

Sûr

Générer une documentation README complète

Cette compétence crée une documentation README.md complète pour tout projet, couvrant la configuration, l'architecture, le déploiement et le dépannage. Parfait pour les développeurs qui souhaitent une documentation de projet complète sans avoir à l'écrire manuellement.

Prend en charge: Claude Codex Code(CC)
⚠️ 62 Médiocre
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "readme". Create a README for my Rails app

Résultat attendu:

Génère un README complet avec : Titre et aperçu du projet, tableau de la stack technique, prérequis, guide de démarrage étape par étape, explication de la structure des répertoires, schéma de la base de données, référence des variables d'environnement, scripts disponibles, instructions de test, guide de déploiement pour la plateforme détectée, section de dépannage

Utilisation de "readme". Document my Node.js project

Résultat attendu:

Crée un README avec : Description du projet, dépendances, instructions de configuration, référence des scripts npm, configuration de l'environnement, aperçu de l'architecture, instructions de déploiement pour la plateforme détectée (Vercel, Render, etc.), étapes de dépannage courantes

Audit de sécurité

Sûr
v1 • 2/24/2026

All 268 static findings are FALSE POSITIVES. This is a documentation generation skill that provides instructions for writing README files. The flagged patterns (external commands, environment variables, URLs) are all example content within the documentation templates, not actual code execution or credential access. No real security risks identified.

1
Fichiers analysés
843
Lignes analysées
5
résultats
1
Total des audits

Problèmes à risque élevé (5)

SKILL.md:75-842
External Commands False Positive
Static scanner flagged 208 instances of 'external_commands' (Ruby/shell backtick execution) - these are example commands in documentation templates, not actual code execution. The skill generates README documentation and does not execute any commands.
SKILL.md:190-633
Environment Access False Positive
Static scanner flagged 16 instances of 'env_access' (DATABASE_URL, SECRET_KEY_BASE, etc.) - these are documented environment variables in example documentation, not actual environment access.
SKILL.md:4-377
Network Access False Positive
Static scanner flagged 6 instances of 'network' (URLs, SMTP settings) - these are example URLs and configuration documentation, not actual network requests.
SKILL.md:45-770
Sensitive Files False Positive
Static scanner flagged references to credentials files (.env.example, credentials.yml.enc, master.key) - these are documentation about configuration files, not actual file access.
SKILL.md:3-555
Weak Cryptographic Algorithm False Positive
Static scanner flagged 10 instances of 'weak cryptographic algorithm' - these are standard Rails terms (encrypted_password, credentials.yml.enc) in documentation, not actual crypto implementation.
Audité par: claude

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
26
Communauté
55
Sécurité
91
Conformité aux spécifications

Ce que vous pouvez construire

Documentation de nouveau projet

Génère un README complet pour un nouveau projet afin de documenter la configuration et l'architecture dès le premier jour.

Mise à jour du README d'un projet existant

Met à jour les fichiers README obsolètes avec des instructions de configuration actuelles, des détails d'architecture et des étapes de déploiement.

Amélioration de projet open source

Crée une documentation complète pour les projets open source afin d'améliorer l'intégration des contributeurs.

Essayez ces prompts

Génération de README de base 
Create a README.md for this project using the readme skill. Explore the codebase first to understand the structure.
Mettre à jour un README existant 
Update the existing README.md with more thorough documentation. The current README is outdated and missing key sections.
Ajouter une section de déploiement 
Add a deployment section to our README. Check for deployment configuration files like Dockerfile, docker-compose.yml, or deploy configs.
Refonte complète de la documentation 
Create an absurdly thorough README that covers everything: local setup, architecture deep-dive, environment variables, testing, deployment, and troubleshooting.

Bonnes pratiques

  • Laisser la compétence explorer entièrement la base de code avant de générer la documentation pour un contenu précis
  • Fournir l'accès à tous les fichiers de configuration (.env.example, database.yml, etc.) pour une documentation complète
  • Vérifier les tableaux de variables d'environnement générés et ajouter toutes les valeurs sensibles manquantes

Éviter

  • Ne pas demander à la compétence de documenter un projet sans lui avoir d'abord donné l'accès aux fichiers
  • Éviter d'interrompre la phase d'exploration - la laisser rassembler tous les détails du projet
  • Ne pas s'attendre à ce que la compétence connaisse la logique métier non évidente dans le code

Foire aux questions

Quels frameworks cette compétence prend-elle en charge ?
Cette compétence fonctionne avec n'importe quel framework. Elle détecte Ruby/Rails, Node.js, Python, Go, et plus encore en examinant les fichiers du projet. Elle adapte ensuite la documentation en conséquence.
Fonctionne-t-elle avec les monorepos ?
La compétence peut documenter des monorepos mais peut avoir besoin d'indications sur les packages ou services à cibler. Fournir un contexte sur la structure du projet.
Peut-elle mettre à jour un README existant ?
Oui. La compétence peut lire un README existant et l'améliorer avec des sections manquantes, ou le réécrire complètement avec un contenu plus complet.
Quelles plateformes de déploiement détecte-t-elle ?
Elle détecte Docker, Kamal, Heroku, Fly.io, Render, Vercel, Netlify, AWS Elastic Beanstalk, Serverless, Kubernetes, et les déploiements VPS génériques.
Quelle est l'exhaustivité de la documentation générée ?
L'objectif est une documentation "absurdement complète". Elle inclut des sections sur la configuration, l'architecture, les variables d'environnement, les scripts, les tests, le déploiement et le dépannage.
Cette compétence exécute-t-elle des commandes ?
Non. Il s'agit d'une compétence de génération de documentation. Elle lit uniquement les fichiers pour comprendre le projet et génère une documentation markdown. Elle n'exécute aucune commande.

Détails du développeur

Auteur

sickn33

Licence

MIT

Dépôt

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/readme

Réf

main

Structure de fichiers

📄 SKILL.md