Compétences documentation-templates
📦

documentation-templates

Sûr

Créez une Documentation Professionnelle Rapidement

Cette compétence fournit des modèles prêts à l'emploi pour les fichiers README, la documentation API, les commentaires de code, les journaux des modifications et les formats de documentation adaptés à l'IA.

Prend en charge: Claude Codex Code(CC)
🥉 74 Bronze
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 "documentation-templates". Utilisez documentation-templates pour créer un README pour une API Node.js

Résultat attendu:

Un README.md complet avec les sections : Titre + Phrase d'accroche, Démarrage Rapide, Fonctionnalités, Tableau de Configuration, Lien vers la Référence API, Directives de Contribution, Licence

Utilisation de "documentation-templates". Utilisez documentation-templates pour documenter un point de terminaison GET /users

Résultat attendu:

Documentation API avec description du point de terminaison, Tableau des Paramètres (id: string, requis), Codes de réponse (200, 404), et exemple de requête/réponse

Utilisation de "documentation-templates". Utilisez documentation-templates pour créer un ADR pour le choix de la base de données

Résultat attendu:

Document ADR avec Statut (Accepté/Déprécié/Remplacé), Contexte (pourquoi la décision est nécessaire), Décision (ce qui a été décidé), Conséquences (compromis)

Audit de sécurité

Sûr
v1 • 2/24/2026

All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.

1
Fichiers analysés
200
Lignes analysées
0
résultats
1
Total des audits
Aucun problème de sécurité trouvé

Motifs détectés

External Command Execution (False Positive)Weak Cryptographic Algorithm (False Positive)System Reconnaissance (False Positive)
Audité par: claude

Score de qualité

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

Ce que vous pouvez construire

Configuration de Nouveau Projet

Générez rapidement la documentation d'un nouveau projet avec des modèles README, documentation API et journal des modifications.

Normes de Documentation

Maintenez un style de documentation cohérent sur les projets d'équipe en utilisant des modèles standardisés.

Intégration d'Agents IA

Créez une documentation que les agents IA comme Claude et Codex peuvent comprendre et utiliser efficacement.

Essayez ces prompts

Créer un README de Base 
Utilisez la compétence documentation-templates pour créer un README.md pour mon projet de [type de projet]. Incluez les sections Démarrage Rapide, Fonctionnalités et Configuration.
Documenter les Points de Terminaison API 
Utilisez la compétence documentation-templates pour créer une documentation API pour mon API REST avec les points de terminaison pour [liste des points de terminaison].
Rédiger des Commentaires de Code 
Utilisez la compétence documentation-templates pour ajouter des commentaires JSDoc à ma fonction qui [décrire le but de la fonction].
Créer un Architecture Decision Record 
Utilisez la compétence documentation-templates pour créer un ADR pour [titre de la décision]. Incluez les sections Contexte, Décision et Conséquences.

Bonnes pratiques

  • Commencez par les sections essentielles (titre, démarrage rapide, fonctionnalités) avant d'ajouter une documentation détaillée
  • Utilisez les modèles comme points de départ et adaptez la structure aux besoins de votre projet
  • Maintenez la documentation à jour - une documentation obsolète est pire que pas de documentation
  • Incluez des exemples dans votre documentation pour aider les utilisateurs à comprendre rapidement

Éviter

  • Ne copiez pas les modèles mot pour mot sans les personnaliser selon le contexte de votre projet
  • Évitez de documenter les détails d'implémentation dans les fichiers README destinés aux utilisateurs
  • Ne sautez pas la section Démarrage Rapide - les utilisateurs veulent démarrer rapidement
  • Évitez d'utiliser des formats de documentation obsolètes que les agents IA ne peuvent pas analyser

Foire aux questions

Avec quels outils cette compétence est-elle compatible ?
Cette compétence fonctionne avec Claude, Codex et Claude Code. Utilisez-la avec les outils Read, Glob et Grep.
Dois-je modifier les modèles ?
Oui, les modèles sont des points de départ. Adaptez les espaces réservés et la structure pour répondre aux besoins spécifiques de votre projet.
Puis-je l'utiliser pour des projets commerciaux ?
Oui, cette compétence est sous licence MIT, permettant une utilisation commerciale avec attribution.
Qu'est-ce que llms.txt ?
llms.txt est un format de documentation conçu pour les robots d'exploration et agents IA. Il fournit une vue structurée que les modèles d'IA peuvent facilement analyser et comprendre.
En quoi est-ce différent des documents générés automatiquement ?
Cette compétence fournit des modèles rédigés par des humains qui privilégient la clarté et la lisibilité. Les documents générés automatiquement manquent souvent de structure et de contexte appropriés.
Cette compétence peut-elle générer du code réel ?
Non, cette compétence génère uniquement des structures et modèles de documentation. Elle ne produit pas de code exécutable.

Détails du développeur

Auteur

sickn33

Licence

MIT

Dépôt

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

Réf

main

Structure de fichiers

📄 SKILL.md