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 des README et de la documentation technique v1.0.0

Utilisez cette ressource pour rédiger des README et de la documentation technique en Markdown

Nouveau

  • 328 téléchargements
  • 192 mentions J'aime
  • 142 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install markdown-documentation-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 rédige ou restructure le README et les documents de votre projet selon des conventions claires. Vous obtenez une documentation qu'un nouveau venu peut suivre, en Markdown.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger des README et de la documentation technique »

Caractéristiques

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

Ressources similaires

Tout voir

Ce que vous obtenez

  • SKILL.md : structure d'un README minimal et d'un README complet
  • SKILL.md : sections installation, usage, licence et badges

Pour qui

  • Votre projet n'a pas de README ou un README incomplet
  • Vous voulez des instructions d'installation claires pour les nouveaux venus

Pas pour qui

    Étiquettes

    • readme
    • documentation
    • markdown
    • projet

    À propos

    Vous dites

    « Rédige le README de ce projet avec l'installation, l'usage et une licence MIT. »

    Carte de la skill « Rédiger des README et de la documentation technique »

    Skill publiée par thebushidocollective sous licence Apache-2.0. 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 des README et de la documentation technique en Markdown
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE3,8 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md6,6 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    thebushidocollective
    Source
    github.com/thebushidocollective/han/tree/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/validation/markdown/skills/markdown-documentation
    Licence
    Apache-2.0

    Notice

    « markdown-documentation » (thebushidocollective, Apache-2.0) 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.