project-documentation
✓Créez un fichier README et une documentation système de haute qualité pour les projets logiciels. À utiliser lorsque vous avez besoin de : (1) rédiger ou mettre à jour la documentation README du projet, (2) ajouter des organigrammes de principe de fonctionnement du système à l'aide de Mermaid, (3) rédiger des instructions d'utilisation détaillées étape par étape, (4) organiser et optimiser les descriptions de configuration (variables d'environnement, fichiers de configuration), (5) rendre la documentation plus conviviale et plus facile à comprendre. Applicable aux projets open source, aux outils internes, aux services API et à tout projet nécessitant une documentation améliorée.
Installation
SKILL.md
Create clear, complete, and user-friendly README and system documentation for software projects.
Information sources: README, package.json, .env.example, main code files (main.ts, app.ts, routes/)
Each step should include: Purpose, commands, expected output, tips, and warnings.
Créez un fichier README et une documentation système de haute qualité pour les projets logiciels. À utiliser lorsque vous avez besoin de : (1) rédiger ou mettre à jour la documentation README du projet, (2) ajouter des organigrammes de principe de fonctionnement du système à l'aide de Mermaid, (3) rédiger des instructions d'utilisation détaillées étape par étape, (4) organiser et optimiser les descriptions de configuration (variables d'environnement, fichiers de configuration), (5) rendre la documentation plus conviviale et plus facile à comprendre. Applicable aux projets open source, aux outils internes, aux services API et à tout projet nécessitant une documentation améliorée. Source : jiffies/project-documentation-skill.
Faits (prêts à citer)
Champs et commandes stables pour les citations IA/recherche.
- Commande d'installation
npx skills add https://github.com/jiffies/project-documentation-skill --skill project-documentation- Catégorie
- ""Rédaction
- Vérifié
- ✓
- Première apparition
- 2026-02-01
- Mis à jour
- 2026-02-18
Réponses rapides
Qu'est-ce que project-documentation ?
Créez un fichier README et une documentation système de haute qualité pour les projets logiciels. À utiliser lorsque vous avez besoin de : (1) rédiger ou mettre à jour la documentation README du projet, (2) ajouter des organigrammes de principe de fonctionnement du système à l'aide de Mermaid, (3) rédiger des instructions d'utilisation détaillées étape par étape, (4) organiser et optimiser les descriptions de configuration (variables d'environnement, fichiers de configuration), (5) rendre la documentation plus conviviale et plus facile à comprendre. Applicable aux projets open source, aux outils internes, aux services API et à tout projet nécessitant une documentation améliorée. Source : jiffies/project-documentation-skill.
Comment installer project-documentation ?
Ouvrez votre terminal ou outil de ligne de commande (Terminal, iTerm, Windows Terminal, etc.) Copiez et exécutez cette commande : npx skills add https://github.com/jiffies/project-documentation-skill --skill project-documentation Une fois installé, le skill sera automatiquement configuré dans votre environnement de programmation IA et prêt à être utilisé dans Claude Code ou Cursor
Où se trouve le dépôt source ?
https://github.com/jiffies/project-documentation-skill
Détails
- Catégorie
- ""Rédaction
- Source
- skills.sh
- Première apparition
- 2026-02-01