doc:update

Crées la documentation pour la fonctionnalité en cours. Mets à jour le readme global du projet si nécessaire. Lie les documents entre eux pour ne pas avoir de documentation orpheline. La documentation est générée dans les répertoire de documentation du projet.

8 stars

Best use case

doc:update is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Crées la documentation pour la fonctionnalité en cours. Mets à jour le readme global du projet si nécessaire. Lie les documents entre eux pour ne pas avoir de documentation orpheline. La documentation est générée dans les répertoire de documentation du projet.

Teams using doc:update should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/update/SKILL.md --create-dirs "https://raw.githubusercontent.com/atournayre/claude-marketplace/main/doc/skills/update/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/update/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How doc:update Compares

Feature / Agentdoc:updateStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Crées la documentation pour la fonctionnalité en cours. Mets à jour le readme global du projet si nécessaire. Lie les documents entre eux pour ne pas avoir de documentation orpheline. La documentation est générée dans les répertoire de documentation du projet.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Documentation de fonctionnalité

## Instructions à Exécuter

**IMPORTANT : Exécute ce workflow étape par étape :**


Génère ou met à jour la documentation pour la fonctionnalité en cours de développement, en s'assurant que tous les documents sont liés et que le README principal est à jour.

## Purpose
Maintenir une documentation cohérente, à jour et bien interconnectée pour le projet.

## Variables
- CURRENT_BRANCH: Branche Git en cours
- DOC_DIR: Répertoire de documentation du projet (détection automatique)
- README_PATH: Chemin vers le README principal du projet
- FEATURE_NAME: Nom de la fonctionnalité extraite de la branche et des modifications

## Relevant Files
- `README.md` - Documentation principale du projet
- `docs/` - Répertoire de documentation standard
- Fichiers source de la fonctionnalité
- Fichiers de tests associés

## Workflow

### 1. Analyse du contexte
- Identifie la branche Git en cours (git branch --show-current)
- Analyse les modifications de la branche :
  - Fichiers modifiés (git status)
  - Diff par rapport à main/master (git diff)
  - Commits de la branche (git log)
- Extrait le nom de la fonctionnalité depuis :
  - Le nom de la branche (ex: feature/user-auth → User Authentication)
  - Les commits de la branche
  - Les prompts récents de la session
- Détermine le répertoire de documentation :
  - Cherche `docs/`, `documentation/`, ou équivalent
  - Crée le répertoire si nécessaire
- Identifie les informations clés :
  - Fichiers principaux modifiés
  - Tests associés
  - Dépendances ajoutées/modifiées

### 2. Génération de la documentation
- Crée ou met à jour le fichier de documentation :
  - Titre et description claire
  - Utilisation et exemples
  - Architecture et composants
  - Configuration nécessaire
  - Tests et validation
  - Limitations et notes
- Format Markdown structuré avec :
  - Table des matières si nécessaire
  - Blocs de code avec syntaxe
  - Liens vers fichiers sources
  - Exemples d'utilisation concrets

### 3. Mise à jour du README principal
- Vérifie si la fonctionnalité doit être mentionnée dans le README
- Ajoute ou met à jour la section appropriée :
  - Fonctionnalités principales
  - Structure du projet
  - Documentation disponible
- Maintient la cohérence du format existant
- Préserve l'ordre et la hiérarchie

### 4. Liaison des documents
- Identifie les documents connexes :
  - Documentation de fonctionnalités liées
  - Guides d'architecture
  - Tutoriels
  - ADRs (Architecture Decision Records)
- Ajoute des liens bidirectionnels :
  - Depuis le nouveau document vers les connexes
  - Depuis les connexes vers le nouveau document
- Vérifie l'absence de liens cassés
- Crée un index si nécessaire pour les projets volumineux

### 5. Validation et rapport
- Vérifie la qualité de la documentation :
  - Tous les exemples sont fonctionnels
  - Les liens sont valides
  - Le formatage Markdown est correct
  - Pas de typos évidentes
- Génère un rapport de ce qui a été créé/modifié

## Report
Affiche un résumé structuré :

```
Documentation générée :
- Fonctionnalité : [NOM]
- Fichier créé/modifié : [CHEMIN]
- Taille : [LIGNES] lignes

Modifications README :
- Section modifiée : [SECTION]
- Ajouts : [DESCRIPTION]

Liens créés :
- [DOC1] ↔ [DOC2]
- [DOC3] ↔ [DOC4]

Documents liés :
- [LISTE DES DOCS CONNEXES]
```

## Best Practices
- Documentation focalisée sur l'utilisation, pas l'implémentation
- Exemples concrets et testés
- Langage clair et concis (style bullet points)
- Liens relatifs pour la portabilité
- Pas de duplication entre README et docs détaillées
- README = vue d'ensemble, docs/ = détails
- Maintenir la cohérence du ton et du format

Related Skills

fix-grammar

8
from atournayre/claude-marketplace

Fix grammar and spelling errors in one or multiple files while preserving formatting

symfony-framework

8
from atournayre/claude-marketplace

Comprehensive Symfony 6.4 development skill for web applications, APIs, and microservices.

symfony:make

8
from atournayre/claude-marketplace

Cherche si il existe un maker Symfony pour faire la tache demandée et l'utilise si il existe. Si aucun maker n'existe alors utilise la slash command "/prepare"

phpstan-resolver

8
from atournayre/claude-marketplace

Résout automatiquement les erreurs PHPStan en analysant et corrigeant les problèmes de types. Boucle jusqu'à zéro erreur ou stagnation.

elegant-objects

8
from atournayre/claude-marketplace

Vérifie la conformité du code PHP aux principes Elegant Objects de Yegor Bugayenko. Analyse un fichier spécifique ou tous les fichiers modifiés dans la branche.

prompt:validate

8
from atournayre/claude-marketplace

Vérifie la checklist avant exécution et liste les oublis

prompt:transform

8
from atournayre/claude-marketplace

Transforme un prompt en prompt exécutable compatible avec le Task Management System (TaskCreate/TaskUpdate/TaskList)

prompt:team

8
from atournayre/claude-marketplace

Orchestre une équipe d'agents spécialisés pour les tâches complexes. Auto-détecte le type, compose l'équipe, coordonne les phases analyse → challenge → implémentation → QA.

prompt:start

8
from atournayre/claude-marketplace

Démarre un développement avec un starter léger puis active le mode plan

apex

8
from atournayre/claude-marketplace

Systematic implementation using APEX methodology (Analyze-Plan-Execute-eXamine) with parallel agents, self-validation, and optional adversarial review. Use when implementing features, fixing bugs, or making code changes that benefit from structured workflow.

fix-errors

8
from atournayre/claude-marketplace

Fix all ESLint and TypeScript errors with parallel processing using snipper agents

prompt-creator

8
from atournayre/claude-marketplace

Expert prompt engineering for creating effective prompts for Claude, GPT, and other LLMs. Use when writing system prompts, user prompts, few-shot examples, or optimizing existing prompts for better performance.