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 de la documentation v1.0.0

Utilisez cette ressource pour écrire ou relire la documentation d'un produit

Nouveau

  • 390 téléchargements
  • 179 mentions J'aime
  • 184 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install technical-docs-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 commence par choisir le type de document (tutoriel, guide pratique, référence, explication), puis applique des règles de voix, de titres, de structure et de terminologie. Vous obtenez une documentation plus courte, cohérente et utile aussi bien aux lecteurs qu'aux LLM.

Mise à jour le 2 novembre 2026

Exemples « à préférer » et « à éviter » de phrases de documentation, et carte Diataxis 2×2.

Caractéristiques

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

Ressources similaires

Tout voir
  • Gratuit

    Vidéo

    Fenêtre d'application et zoom

    • 365365 téléchargements
    • 125125 mentions J'aime
    • 188188 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • Gratuit

    Vidéo

    Un seul grand chiffre

    • 463463 téléchargements
    • 223223 mentions J'aime
    • 100100 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • PRO

    Vidéo

    PalateKit Motion, la bibliothèque

    • 338338 téléchargements
    • 198198 mentions J'aime
    • 249249 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • PRO

    Vidéo

    Trois barres face à face

    • 348348 téléchargements
    • 133133 mentions J'aime
    • 182182 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • PRO

    Vidéo

    Avant / après au curseur

    • 322322 téléchargements
    • 248248 mentions J'aime
    • 238238 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • PRO

    Vidéo

    Carrousel de trois cartes

    • 418418 téléchargements
    • 157157 mentions J'aime
    • 101101 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • PRO

    Vidéo

    Échange en bulles

    • 564564 téléchargements
    • 127127 mentions J'aime
    • 161161 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames
  • PRO

    Vidéo

    Liste qui se coche

    • 442442 téléchargements
    • 233233 mentions J'aime
    • 160160 sauvegardes
    Compatible avec
    • Claude Code
    • Codex
    • Cursor
    • et 3 autres
    + HyperFrames

Ce que vous obtenez

  • SKILL.md traduit en français : voix, structure, cohérence, pièges et liste de contrôle
  • references/diataxis-compass.md : la boussole et la carte Diataxis, avec le modèle de qualité

Pour qui

  • Vous rédigez la documentation ou le centre d'aide d'un produit
  • Vous voulez relire des pages d'aide pour les rendre plus claires
  • Vous devez uniformiser la terminologie d'une équipe

Pas pour qui

  • Écrire des textes marketing ou des articles de blog
  • Générer de la documentation de code automatique à partir de sources

Étiquettes

  • documentation
  • style
  • diataxis
  • rédaction
  • aide

À propos

Vous dites

« Relis ces pages d'aide avec le guide de style et dis-moi de quel type Diataxis est chacune. »

Exemples « à préférer » et « à éviter » de phrases de documentation, et carte Diataxis 2×2.

Skill publiée par existential-birds sous licence Apache-2.0, traduite par PalateKit.

Voir plus

Prérequis

À préparer
Les pages de documentation à écrire ou à relire et La liste des termes de votre produit, si elle existe

Comment l'utiliser

  1. Placez la skill dans le dossier de skills de votre agent
  2. Donnez les pages à écrire ou à relire
  3. Parcourez la liste de contrôle avec l'agent avant de publier

Aperçu du contenu

Fichiers

  • LICENSE10,7 Ko
  • NOTICE-PALATEKIT.md0,5 Ko
  • references/diataxis-compass.md6,1 Ko
  • SKILL.md12,1 Ko

Origine et licence

Modifié par PalateKit

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

Notice

Version modifiée de « docs-style » (existential-birds, Apache-2.0) : traduction française et fiche 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.

Questions fréquentes

La skill mentionne des skills voisines (tutorial-docs, howto-docs…). Sont-elles nécessaires ?

Non. Ce sont des renvois facultatifs ; le guide et la boussole fonctionnent seuls.

Les exemples sont-ils tous techniques ?

Oui, ils viennent de la documentation d'API, mais les règles (voix active, titres clairs, un terme par concept) valent pour tout texte d'aide.