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 ou mettre à jour la documentation technique v1.0.0

Utilisez cette ressource pour rédiger ou mettre à jour la documentation d'un code, d'une API ou d'un système

Nouveau

  • 499 téléchargements
  • 221 mentions J'aime
  • 109 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install technical-documentation-writing-4

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 choisit le type de document adapté (README, documentation d'API, commentaires, guide technique, ADR) et le rédige pour son lecteur. Vous obtenez une documentation claire, prête à être relue et publiée.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger ou mettre à jour la documentation technique »

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 : les cinq types de documentation et leurs lecteurs
  • SKILL.md : principes de rédaction et modèle de README

Pour qui

  • Votre projet n'a pas de README à jour
  • Vous voulez documenter une API pour les développeurs qui l'utilisent

Pas pour qui

    Étiquettes

    • documentation
    • readme
    • api

    À propos

    Vous dites

    « Rédige le README de ce module et documente ses fonctions publiques. »

    Carte de la skill « Rédiger ou mettre à jour la documentation technique »

    Skill publiée par thebushidocollective 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 ou mettre à jour la documentation d'un code, d'une API ou d'un système
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE3,8 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md15,9 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    thebushidocollective
    Source
    github.com/thebushidocollective/han/tree/19caa51d5fd144ef6b2764f2332f4c856aa5d1af/plugins/core/skills/document
    Licence
    Apache-2.0

    Notice

    « document » (thebushidocollective, 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.