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
Rédiger la documentation d'un projet v1.0.0
Utilisez cette ressource pour générer ou améliorer la documentation d'un code, d'une API ou d'un dépôt
Nouveau
- 596 téléchargements
- 123 mentions J'aime
- 214 sauvegardes
Gratuit
Installer avec la CLI
Dans un terminal, depuis le dossier voulu :
npx --yes palatekit@latest install code-documentation-writerSans 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 parcourt l'arborescence, lit les fichiers clés et les surfaces publiques de l'API, puis rédige la documentation adaptée à la taille du projet. Vous obtenez des documents exacts, structurés pour les nouveaux contributeurs.
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 : méthode d'analyse de la base de code en trois étapes
- SKILL.md : modèles de README, de référence d'API et de guides développeur
Pour qui
- Votre projet n'a pas de README ou un README périmé
- Vous voulez une référence d'API à partir du code existant
Pas pour qui
Étiquettes
- documentation
- readme
- api
- développeur
À propos
Vous dites
« Rédige le README de ce dépôt avec installation, utilisation et une référence des fonctions publiques. »
Skill publiée par bytedance 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 générer ou améliorer la documentation d'un code, d'une API ou d'un dépôt
- Relisez et ajustez le résultat
Aperçu du contenu
Fichiers
- LICENSE1,1 Ko
- NOTICE-PALATEKIT.md0,5 Ko
- SKILL.md13,6 Ko
Origine et licence
Référencée sans modification
- Auteur
- bytedance
- Source
- github.com/bytedance/deer-flow/tree/f42076a005e3ba7fa23e61012f2ac9098917af20/skills/public/code-documentation
- Licence
- MIT
Notice
« code-documentation » (bytedance, 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…