Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Se connecter
Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Une page, une vidéo ou une image en ligne.

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.

Bonnes pratiques de documentation technique v1.0.0

Utilisez cette ressource pour écrire une documentation technique claire et à jour

Nouveau

  • 199 téléchargements
  • 170 mentions J'aime
  • 41 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install technical-documentation-rules

Première fois : connectez la CLI avec

npx --yes palatekit@latest login

Le prompt donne une vingtaine de règles pour la documentation d'un projet : exemples de code testés, référence générée depuis le source, titres orientés tâche, prérequis en tête de guide, relecture avec un outil de style et journal des modifications. Vous obtenez une grille de relecture pour vos pages techniques.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte du prompt « Bonnes pratiques de documentation technique »

Caractéristiques

Fonctionne dans
Guides d'installation
Génère avec
Le modèle de votre agent
Licence
CC0-1.0

Ressources similaires

Tout voir

Ce que vous obtenez

  • Le prompt complet, en anglais, prêt à coller
  • Règles sur la structure, les exemples et la maintenance
  • Une liste de contrôle à appliquer à chaque page

Pour qui

  • Une équipe qui reprend une documentation obsolète
  • Un guide d'installation à relire avant une sortie

Pas pour qui

    Étiquettes

    • documentation
    • rédaction technique
    • guide
    • relecture

    À propos

    Vous dites

    « Réécris cette page d'installation selon ces règles, avec les prérequis en haut. »

    Carte du prompt « Bonnes pratiques de documentation technique »

    Prompt publié par f sous licence CC0-1.0. Livré dans sa version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Collez le prompt dans votre assistant ou votre agent
    2. Demandez-lui de écrire une documentation technique claire et à jour
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE0,6 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • technical-documentation-rules.md2,4 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    f
    Source
    github.com/f/prompts.chat/blob/cecef6fc73c2c389770695a56252d331981727de/prompts.csv
    Licence
    CC0-1.0

    Notice

    « Technical Documentation taste » (f, CC0-1.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.