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

PalateKit

Menu

Demander une ressource

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

0 / 280

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.

Rédiger une documentation de projet claire v1.0.0

Utilisez cette ressource pour rédiger ou réviser un README sans recopier le code du projet

Nouveau

  • 329 téléchargements
  • 142 mentions J'aime
  • 115 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install project-docs-glossary-writing

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 garde le pourquoi, les principes et les points que le code ne dit pas, retire le récit et les listes qui se périment, supprime les doublons et relie la racine aux sous-documents. Vous obtenez une documentation courte qui ne dérive pas du code.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger une documentation de projet claire »

Caractéristiques

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

Ressources similaires

Tout voir

Ce que vous obtenez

  • SKILL.md : critères de conservation et de suppression
  • SKILL.md : passage d'édition et liens vers les sous-documents

Pour qui

  • Votre README recopie la liste des fichiers et des commandes
  • Deux documents expliquent le même point

Pas pour qui

    Étiquettes

    • documentation
    • readme
    • principes
    • rédaction

    À propos

    Vous dites

    « Réduis ce README à ses principes et supprime les listes de fichiers qui se périment. »

    Carte de la skill « Rédiger une documentation de projet claire »

    Skill publiée par dzhng 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 ou réviser un README sans recopier le code du projet
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md3,7 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    dzhng
    Source
    github.com/dzhng/jevgrep/tree/9971e04061e43f91f1d248353fd057288bfd24cf/.agents/skills/write-docs
    Licence
    MIT

    Notice

    « write-docs » (dzhng, 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.