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 référence d'API v1.0.0

Utilisez cette ressource pour rédiger des pages de référence précises pour une API ou des symboles

Nouveau

  • 391 téléchargements
  • 171 mentions J'aime
  • 113 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install api-reference-docs-2

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 applique un gabarit de page de référence : nom, paramètres dans un tableau, retours, exemple et liens. Il respecte des principes d'écriture qui décrivent sans expliquer et laissent la structure refléter le produit. Vous obtenez des pages faciles à parcourir pour des lecteurs expérimentés.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger une documentation de référence d'API »

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 : gabarit de page de référence (nom, paramètres, retours, exemple)
  • SKILL.md : principes d'écriture, descriptions précises et concision

Pour qui

  • Vous documentez les fonctions ou les endpoints d'une API publique
  • Vos développeurs cherchent des paramètres précis

Pas pour qui

    Étiquettes

    • référence
    • api
    • paramètres
    • documentation

    À propos

    Vous dites

    « Rédige la page de référence de la fonction createInvoice : paramètres, retours et exemple. »

    Carte de la skill « Rédiger une documentation de référence d'API »

    Skill publiée par existential-birds 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 pages de référence précises pour une API ou des symboles
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE10,7 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md11,4 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    existential-birds
    Source
    github.com/existential-birds/beagle/tree/d1a74899fbfec74974d1818e4cac7c3d54d44b65/plugins/beagle-docs/skills/reference-docs
    Licence
    Apache-2.0

    Notice

    « reference-docs » (existential-birds, 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.