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.

Guide de style pour la documentation d'API v1.0.0

Utilisez cette ressource pour rédiger et relire la documentation d'API, de SDK et les tutoriels selon un même style

Nouveau

  • 571 téléchargements
  • 165 mentions J'aime
  • 143 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install api-documentation-style-guide

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 au texte les règles de ton, de vocabulaire, de structure des points de terminaison et de mise en forme des exemples de code. Vous obtenez une relecture conforme et des modèles pour les erreurs, la pagination et les mentions de version.

Mise à jour le 2 novembre 2026

Carte de la skill « Guide de style pour la documentation 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 : règles de ton, de terminologie et de structure
  • SKILL.md : conventions des exemples de code, pagination et erreurs

Pour qui

  • Vous rédigez la référence d'une API ou d'un SDK
  • Plusieurs contributeurs publient une documentation aux styles différents

Pas pour qui

    Étiquettes

    • api
    • documentation
    • style
    • sdk

    À propos

    Vous dites

    « Relis cette page sur la pagination de notre API et corrige-la selon notre guide : ton, en-têtes et exemples de code. »

    Carte de la skill « Guide de style pour la documentation d'API »

    Skill publiée par gtmagents 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 et relire la documentation d'API, de SDK et les tutoriels selon un même style
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE11,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md1,4 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    gtmagents
    Source
    github.com/gtmagents/gtm-agents/tree/78e0419f4440bcb43bc80127e174ecf5adef1753/plugins/technical-writing/skills/api-style-guide
    Licence
    Apache-2.0

    Notice

    « api-style-guide » (gtmagents, 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.