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.

Rédiger un README adapté à son public v1.0.0

Utilisez cette ressource pour rédiger ou améliorer un README adapté à son public et à son projet

Nouveau

  • 524 téléchargements
  • 215 mentions J'aime
  • 217 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install readme-writing-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 vous demande qui lira le document et ce que ce lecteur doit savoir, puis choisit un modèle et une structure de sections. Vous obtenez un README complet, pour un projet open source, interne ou personnel.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger un README adapté à son public »

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

  • SKILL.md : processus en trois étapes, de la tâche aux questions à poser
  • templates/ : modèles open source, interne et personnel ; style-guide.md : règles de rédaction

Pour qui

  • Votre dépôt open source n'a pas de README ou un README obsolète
  • Vous devez documenter un outil interne pour votre équipe

Pas pour qui

    Étiquettes

    • readme
    • documentation
    • open source
    • modèle
    • rédaction

    À propos

    Vous dites

    « Écris le README de ce dépôt open source : c'est une bibliothèque de formatage de dates. »

    Carte de la skill « Rédiger un README adapté à son public »

    Skill publiée par softaworks 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 améliorer un README adapté à son public et à son projet
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE1,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • README.md6,2 Ko
    • references/art-of-readme.md24,4 Ko
    • references/make-a-readme.md6,6 Ko
    • references/standard-readme-example-maximal.md1,6 Ko
    • references/standard-readme-example-minimal.md0,2 Ko
    • references/standard-readme-spec.md9,9 Ko
    • section-checklist.md0,7 Ko
    • SKILL.md2,7 Ko
    • style-guide.md0,4 Ko
    • templates/internal.md2 Ko
    • templates/oss.md1,7 Ko
    • templates/personal.md1,1 Ko
    • templates/xdg-config.md1,5 Ko
    • using-references.md1,3 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    softaworks
    Source
    github.com/softaworks/agent-toolkit/tree/3027f20f3181758385a1bb8c022d4041dfb4de84/skills/crafting-effective-readmes
    Licence
    MIT

    Notice

    « crafting-effective-readmes » (softaworks, 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.