GratuitSkills
Commits, branches et synchronisation avec la CLI but
- 361361 téléchargements
- 198198 mentions J'aime
- 103103 sauvegardes
Compatible avec
- Claude Code
- Codex
- Cursor
- et 3 autres
Modèles de README, de documentation d'API et de commentaires v1.0.0
Utilisez cette ressource pour rédiger le README et la documentation d'un projet
Nouveau
- 556 téléchargements
- 180 mentions J'aime
- 103 sauvegardes
Gratuit
Installer avec la CLI
Dans un terminal, depuis le dossier voulu :
npx --yes palatekit@latest install documentation-templates-readme-apiSans option, la skill va dans ~/.agents/skills/ ; ajoutez --agent claude-code (ou codex, cursor…) pour viser un agent.
Première fois : connectez la CLI avec
npx --yes palatekit@latest loginL'agent ordonne les sections d'un README par priorité, applique un modèle de documentation d'API par point d'accès et rédige les commentaires de code utiles. Vous obtenez une documentation complète et claire pour les humains comme pour les agents.
Choisie surtout par
Mise à jour le 2 novembre 2026
Aperçus
Caractéristiques
- Fonctionne dans
- Guides d'installation
- Génère avec
- Le modèle de votre agent
- Licence
- MIT
Ressources similaires
Tout voir- Gratuit
GratuitSkills
Guide de la CLI Sentry
- 525525 téléchargements
- 117117 mentions J'aime
- 128128 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Bonnes pratiques Drizzle ORM avec PostgreSQL
- 407407 téléchargements
- 194194 mentions J'aime
- 151151 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Assistant de conception de SLO
- 537537 téléchargements
- 105105 mentions J'aime
- 242242 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
User stories de sprint
- 451451 téléchargements
- 150150 mentions J'aime
- 132132 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Plan de sprint réaliste
- 423423 téléchargements
- 192192 mentions J'aime
- 102102 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Conseiller CTO de startup
- 580580 téléchargements
- 201201 mentions J'aime
- 242242 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
GratuitSkills
Création de pull requests GitHub avec contrôles qualité
- 427427 téléchargements
- 230230 mentions J'aime
- 196196 sauvegardes
Compatible avec- Claude Code
- Codex
- Cursor
- et 3 autres
Ce que vous obtenez
- SKILL.md : ordre des sections du README et modèle complet
- SKILL.md : structure de la documentation d'API et modèle par point d'accès
- SKILL.md : règles pour les commentaires de code et la documentation destinée aux IA
Pour qui
- Votre projet n'a pas de README ou un README qui ne donne pas envie d'essayer
- Vous devez documenter une API pour des développeurs externes
Pas pour qui
Étiquettes
- readme
- documentation
- api
- commentaires
À propos
Vous dites
« Rédige le README de mon CLI, avec installation, démarrage rapide et configuration. »
Skill publiée par davila7 sous licence MIT. Fichiers livrés dans leur version d'origine, en anglais.
Voir plusVoir moins
Comment l'utiliser
- Installez la skill dans le dossier de skills de votre agent
- Demandez à votre agent de rédiger le README et la documentation d'un projet
- Relisez et ajustez le résultat
Aperçu du contenu
Fichiers
- LICENSE1,1 Ko
- NOTICE-PALATEKIT.md0,5 Ko
- SKILL.md3,4 Ko
Origine et licence
Référencée sans modification
- Auteur
- davila7
- Source
- github.com/davila7/claude-code-templates/tree/f57964ebda91cdfb31755661ecea9395f30020f1/cli-tool/components/skills/document-processing/documentation-templates
- Licence
- MIT
Notice
« documentation-templates » (davila7, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.
Avis des utilisateurs
–
Aucune note pour l'instant
Chargement des avis…