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édaction de documentation projet lisible v1.0.0

Utilisez cette ressource pour rédiger le README, les guides et les runbooks d'un projet

Nouveau

  • 510 téléchargements
  • 122 mentions J'aime
  • 105 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install project-docs-writer

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 écrit ou met à jour la documentation destinée aux humains : README, guides dans docs/, procédures d'exploitation. Il ne touche ni aux commentaires de code ni aux exigences. Vous obtenez des pages claires, qui suivent le guide de style de la skill.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédaction de documentation projet lisible »

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 : périmètre, flux de travail et interdits
  • references/style-guide.md : guide de style de la documentation

Pour qui

  • Votre README ne permet pas à un nouveau contributeur d'installer le projet
  • Vous devez documenter une procédure de déploiement

Pas pour qui

    Étiquettes

    • documentation
    • readme
    • guides
    • runbook

    À propos

    Vous dites

    « Écris le guide d'installation locale du projet pour un nouveau développeur. »

    Carte de la skill « Rédaction de documentation projet lisible »

    Skill publiée par nextstage-brasil 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 le README, les guides et les runbooks d'un projet
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • evals/evals.json0,7 Ko
    • LICENSE11,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • references/style-guide.md1,3 Ko
    • SKILL.md2,8 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    nextstage-brasil
    Source
    github.com/nextstage-brasil/skills/tree/397947265cb478166f5a110dc869afd1f8f3c04c/skills/ns-docs-writer
    Licence
    Apache-2.0

    Notice

    « ns-docs-writer » (nextstage-brasil, 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.