Guide de lecture localisé
documentationObjectif, utilisation et source
Rédiger et tenir à jour la documentation technique. Déclencher une alerte avec les messages « rédiger la documentation pour », « documenter ceci », « créer un fichier README », « rédiger un manuel d'exploitation », « guide d'intégration » ou lorsque l'utilisateur a besoin d'aide pour toute forme de rédaction technique : documentation API, documentation d'architecture ou manuels d'exploitation.
Source récupérée:
- Dépôt source
- anthropics/knowledge-work-plugins
- SKILL.md
engineering/skills/documentation/SKILL.md- Étoiles du dépôt
- 34,049
- Mise à jour du dépôt
- 2026-10-30
- Catégories de capacités
- Documents
- Dernière collecte
Licence : Apache-2.0
Les extraits de flux de travail sont des outils de lecture et non des instructions exécutables de Codez. Aucune compétence tierce n'a été utilisée pour générer cette page.
Les passages relatifs à l'objectif et au flux de travail ci-dessous constituent le contenu original, organisé et traduit pour la lecture. Ils sont distincts de l'analyse éditoriale de Codez, qui est étiquetée séparément.
À quoi sert cette compétence ?
Rédiger et tenir à jour la documentation technique. Déclencher une alerte avec les messages « rédiger la documentation pour », « documenter ceci », « créer un fichier README », « rédiger un manuel d'exploitation », « guide d'intégration » ou lorsque l'utilisateur a besoin d'aide pour toute forme de rédaction technique : documentation API, documentation d'architecture ou manuels d'exploitation.
Comment fonctionne le flux de travail en amont
Documentation technique
Rédiger une documentation technique claire et facile à maintenir, adaptée à différents publics et à différents objectifs.
passage en amont · L6 ↗Lisez-moi
Qu'est-ce que c'est et pourquoi cela existe ? Démarrage rapide (<5minutes avant le premier succès)
passage en amont · L12 ↗Documentation de l'API
Référence de point de terminaison avecrequest/responseExemples : Authentification et codes d’erreur
passage en amont · L18 ↗Configuration requise
Aucun extrait de configuration n'a été sélectionné dans ce fichier. Cela ne signifie pas que la compétence est sans dépendances. Consultez les instructions de configuration du dépôt et les fichiers référencés.
Limites et contrôles de qualité
Aucun passage de limite distinct n'a été sélectionné dans ce fichier. Cela ne signifie pas que la compétence est sûre pour toutes les entrées ou tous les environnements. Consultez le code source complet et validez vos résultats.
Commencez par un essai sans danger
- Vérifiez l'hôte pris en charge et les instructions d'installation du dépôt. Conservez le répertoire Skill ainsi que ses scripts, ressources et documentation référencés ;SKILL.mdSeul, il peut omettre les dépendances.
- Indiquez à l'agent vos paramètres d'entrée réels, le résultat souhaité et les critères d'acceptation. La syntaxe d'appel et les outils disponibles dépendent du système hôte ; ce site ne propose pas de commande d'installation universelle.
- Testez le flux de travail source dans un projet temporaire ou sur une copie. Avant d'autoriser les opérations qui modifient des fichiers, des services distants ou des ressources facturables, examinez-les attentivement.
- Vérifiez la conformité du résultat avec les contrôles qualité sources et vos propres exigences. Un déclenchement réussi ou un nombre élevé d'étoiles dans le dépôt ne garantissent pas un résultat correct.
Pour en savoir plus, consultez la source.
Compétences connexes
Traduction et étendue
Ce guide de lecture sélectionne des passages de l'amont épingléSKILL.mdCette traduction est assistée. Elle ne constitue pas un manuel complet et ne garantit pas une compatibilité testée. Veuillez lire le document original et les fichiers auxquels il fait référence avant utilisation.
Cette introduction fait référence à la version épinglée ci-dessous ; l’activité actuelle du dépôt et la durée de la collecte sont indiquées séparément.
- Source épinglée
- Lire l'original ↗
- Source récupérée
- Commit source
2574e29377c7173d0cecffef29a6ecbd7f8ccb5d- Source SHA-256
1d469418f786a05be83d2a05f04d68788aeed584d13863a650f5ad73c6c4cf50