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 technique utile v1.0.0

Utilisez cette ressource pour rédiger une documentation technique claire et maintenable

Nouveau

  • 437 téléchargements
  • 215 mentions J'aime
  • 192 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

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

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 identifie le lecteur et ses questions, puis produit ou relit un README, un commentaire, une décision d'architecture ou un guide d'intégration. Vous obtenez des documents courts, à jour et centrés sur les usages.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger une documentation technique utile »

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 : principes de rédaction et méthode de l'agent
  • references/patterns.md : formats de README, d'ADR et de guides
  • references/sharp_edges.md : documentations obsolètes ou inutiles et leurs causes

Pour qui

  • Votre projet n'a pas de README ou un README qui ne décrit plus l'installation
  • Vous devez documenter une API pour des développeurs externes

Pas pour qui

    Étiquettes

    • documentation
    • readme
    • api
    • rédaction
    • architecture

    À propos

    Vous dites

    « Rédige le README d'installation de ce dépôt pour un développeur qui ne connaît pas le projet. »

    Carte de la skill « Rédiger une documentation technique utile »

    Skill publiée par omer-metin 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 une documentation technique claire et maintenable
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE10,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • references/patterns.md14,4 Ko
    • references/sharp_edges.md13,3 Ko
    • references/validations.md7,7 Ko
    • SKILL.md3,3 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    omer-metin
    Source
    github.com/omer-metin/skills-for-antigravity/tree/e8dcf4e8737921a10088bd5c9eb65e81f74c051f/skills/technical-writer
    Licence
    Apache-2.0

    Notice

    « technical-writer » (omer-metin, 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.