Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Se connecter
Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Une page, une vidéo ou une image en ligne.

Débloquer PalateKit

Tout débloquer

Offre

Le paiement vaut acceptation de nos conditions générales de vente.

Paiement sécurisé par Stripe. Reçus et factures envoyés par e-mail.

Content de vous revoir

Connectez-vous pour installer, télécharger ou sauvegarder cette ressource. Un compte gratuit suffit pour les ressources gratuites.

Modèles de documentation technique : README, API, code v1.0.0

Utilisez cette ressource pour rédiger un README, une documentation d'API ou des commentaires de code

Nouveau

  • 553 téléchargements
  • 231 mentions J'aime
  • 146 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install technical-documentation-templates

Sans 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 login

L'agent s'appuie sur des modèles pour structurer un README par ordre de priorité, documenter chaque endpoint, rédiger des commentaires JSDoc ou TSDoc et tenir un changelog. Vous obtenez une documentation complète, sans sections superflues.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Modèles de documentation technique : README, API, code »

Caractéristiques

Fonctionne dans
Guides d'installation
Génère avec
Le modèle de votre agent
Licence
MIT

Ressources similaires

Tout voir

Ce que vous obtenez

  • sub-skills/readme-template.md : modèle de README
  • sub-skills/per-endpoint-template.md : modèle de documentation par endpoint
  • sub-skills/jsdoctsdoc-template.md : modèle de commentaires JSDoc et TSDoc

Pour qui

  • Votre dépôt n'a pas de README utilisable par un nouvel arrivant
  • Votre API publique n'a pas de description par endpoint

Pas pour qui

    Étiquettes

    • documentation
    • readme
    • api
    • jsdoc

    À propos

    Vous dites

    « Rédige le README de ce dépôt avec les sections essentielles, dans l'ordre de priorité. »

    Carte de la skill « Modèles de documentation technique : README, API, code »

    Skill publiée par dokhacgiakhoa sous licence MIT. Fichiers livrés dans leur version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Installez la skill dans le dossier de skills de votre agent
    2. Demandez à votre agent de rédiger un README, une documentation d'API ou des commentaires de code
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE2,4 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md1 Ko
    • sub-skills/added.md0 Ko
    • sub-skills/changed.md0 Ko
    • sub-skills/essential-sections-priority-order.md0,3 Ko
    • sub-skills/fixed.md0,3 Ko
    • sub-skills/jsdoctsdoc-template.md0,3 Ko
    • sub-skills/llmstxt-template.md0,3 Ko
    • sub-skills/mcp-ready-documentation.md0,5 Ko
    • sub-skills/per-endpoint-template.md0,3 Ko
    • sub-skills/readme-template.md0,4 Ko
    • sub-skills/when-to-comment.md0,3 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    dokhacgiakhoa
    Source
    github.com/dokhacgiakhoa/agent-skills-4-vibe-coding-cli/tree/c4a059bbf7a8d6b2162071f0fbfe74053faa6d20/.agent/skills/documentation-templates
    Licence
    MIT

    Notice

    « documentation-templates » (dokhacgiakhoa, 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…

    Supprimer votre avis ?

    Votre note et votre commentaire seront retirés de la fiche.