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 lue par les développeurs v1.0.0

Utilisez cette ressource pour rédiger une documentation que les développeurs lisent

Nouveau

  • 577 téléchargements
  • 226 mentions J'aime
  • 203 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install developer-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 vous aide à rédiger une documentation claire : README, documentation d'API, tutoriels et docs internes, structurés pour que le lecteur trouve vite ce dont il a besoin. Vous obtenez un plan de documentation et des textes prêts à relire.

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger une documentation lue par les développeurs »

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 : rôle de rédacteur de documentation technique
  • references/patterns.md : structures de README et de tutoriels
  • references/sharp_edges.md : erreurs qui rendent une documentation inutile

Pour qui

  • Votre README ne permet pas de démarrer le projet en cinq minutes
  • Votre API est utilisée mais sa documentation décourage les développeurs

Pas pour qui

    Étiquettes

    • documentation
    • readme
    • api
    • tutoriel

    À propos

    Vous dites

    « Réécris le README de mon paquet npm : installation, premier exemple et tableau des options. »

    Carte de la skill « Rédiger une documentation lue par les développeurs »

    Skill publiée par omer-metin 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 une documentation que les développeurs lisent
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE10,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • references/patterns.md7,1 Ko
    • references/sharp_edges.md6,8 Ko
    • references/validations.md2,2 Ko
    • SKILL.md1,7 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    omer-metin
    Source
    github.com/omer-metin/skills-for-antigravity/tree/e8dcf4e8737921a10088bd5c9eb65e81f74c051f/skills/documentation-that-slaps
    Licence
    Apache-2.0

    Notice

    « documentation-that-slaps » (omer-metin, 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.